JavaDoc 読解 Mapインターフェースクラス～使い方も記載～

イントロダクション

プログラミングの主な用途としては、データの処理、文字列をくっつけたり、右の情報と左の情報をくっつけたり、もちろん逆に切り離したり。。。
イメージとしては、レゴブロックのように、くっつけて、ばらしてを繰り返して別な形にするということが往々にしてあります。

それというのは、情報を改ざんさせないためだったり、作成者の考えた仕組みを作る理由で。。。などいろんな理由でデータの操作が必要になります。
そこで標準的に使えるのが、データをそのまま取得するListや配列、他にはキーと値(Value)をセットにして保持するMapがあります。

インタフェースMap<K,V>

Java Docの解釈を行います。
「既知のすべての実装クラス:」と書いてある部分は
javaAPIで提供されているクラスです。
→java.util.Mapをインポートすればおっけ

例：import java.util.Map
実装のサンプルはこちら

Mapの実装クラス(インターフェースでない)は
サンプルコードではHashMapとPropertiesを記載しています。

Mapの使い方

Mapインターフェースクラスは、既存の実装クラスとして、ほかにもあるのですが、よく使うものとしてHashMapがあります。他にも、LinkedHashMapもあり、ListのArrayListとLinkedListのような関係です。

putとget

Mapは、基本的に下のような操作を行います。

「put」メソッドで値をセット
「get」メソッドで値を取得します。

Mapの使用例：じゃんけんゲーム

Mapを使用したサンプル。じゃんけんゲームでの各パターンをセットする。
じゃんけんの各手を以下のように定義してそれぞれのキー(パターン)に対応した結果を取得する

じゃんけんの判定はint型

変数名	値
YOU_WIN	0
YOU_LOOSE	1
AIKO	2

各手は文字列型

変数名	値
GU	"0"
CHOKI	"1"
PA	"2"

＜プレーヤーの価値ケース＞
GU + CHOKI = "01"; => マップのキー

/* 勝敗判定フラグ：勝ち(ユーザー) */
final int YOU_WIN = 0;
/* 勝敗判定フラグ：負け(ユーザー) */
final int YOU_LOOSE = 1;
/* 勝敗判定フラグ：あいこ(ユーザー) */
final int AIKO = 2;
/* グー */
final String GU = "0";
/* チョキ */
final String CHOKI = "1";
/* パー */
final String PA = "2";

// 勝敗判定マップを作成
Map<String, Integer> hanteiMap = new HashMap<String, Integer>();
// プレーヤーの勝ちケース
hanteiMap.put(GU + CHOKI, YOU_WIN);
hanteiMap.put(CHOKI + PA, YOU_WIN);
hanteiMap.put(PA + GU, YOU_WIN);
// プレーヤーの負けケース
hanteiMap.put(GU + PA, YOU_LOOSE);
hanteiMap.put(CHOKI + GU, YOU_LOOSE);
hanteiMap.put(PA + CHOKI, YOU_LOOSE);
// あいこのケース
hanteiMap.put(GU + GU, AIKO);
hanteiMap.put(CHOKI + CHOKI, AIKO);
hanteiMap.put(PA + PA, AIKO);

※PropertiesはMapと違う部分がありますが
概ね一緒です、細かいところはサンプルコードをみてください

Mapの使い方：そのほか

Mapはキーと値をセットにしているので
「contains」メソッドでキーや、値の有無をチェックしたり
Listクラスの様に「forEach」でループしたりと色々できます。

マスターデータとのリンク

下のように処理を行うときにMapで処理を行うと簡単にできます。

マスターデータのキーを取得する
マップからキーに対応するデータの有無をチェック
マップにキーがあればデータの取得とリストへの登録

// マスタカテゴリ設定とのリンク
String mstKey = data.getMaster();
if (masterMap.containsKey(mstKey)) {
    RpgMaster mst = masterMap.get(mstKey);
    // パラメータ定義のキーリストに追加
    mst.getChildList().add(data.getKigo());
}

ゲームのマップを作る

これも、Mapインターフェースクラスを使用して作成することができます。
タイルの１つ１つがキーと値の関係になっていて、値にはイメージ(画像)がセットされています。

Mapインターフェースクラスはリストインターフェースクラスと並び使用頻度の高いクラスです。

他にもTreeMapなどがあり、ソート(並び替え)が自動でできます。

並び替えはまた後日・・・

JavaFX関連ページ

ステップアップ関連ページ一覧

JavaFX + ND4Jで機械学習準備

オブジェクト指向関連ページ

[オブジェクト指向の概念1〜OracleDocのチュートリアル１〜](https://zenryokuservice.com/wp/2019/10/301. /%e3%82%aa%e3%83%96%e3%82%b8%e3%82%a7%e3%82%af%e3%83%88%e6%8c%87%e5%90%91%e3%81%ae%e6%a6%82%e5%bf%b5-%e3%80%9coracledoc%e3%81%ae%e3%83%81%e3%83%a5%e3%83%bc%e3%83%88%e3%83%aa%e3%82%a2%e3%83%ab%ef%bc%91/)
オブジェクト指向の概念2〜クラスとは〜

Java Doc 読解 System

イントロダクション

「System.out.println()」で使用するクラス、SystemクラスのJavaDocを読んでみます。

Systemクラスの特徴

Systemクラスは、staticメソッドばかりが定義されているので、System.XXX()と使用することが多いです。
このクラスのJavaDocを見てみるといろいろと発見があると思うので、これを勧めたいというわけです。

Systemクラス

java.lang.Systemクラス(JDK ver1.8)のJavaDoc 読解です。とはいっても、一部の使えそうなメソッドを読んでその意味を記載したものになります。

＜よく使用するコード＞

System.out.println("何かしらの文字列");
// Javaを起動しているシステム(OS)の改行コードを取得する
String SEP = System.lineSeparator();

使い方

基本的に「new」しないで使用します。コードでは、System.メソッド名(フィールド名)の様に使用します。
このようなメソッドの呼び出し肩を静的呼び出し(static呼び出し)と筆者は読んでます。一般的でないかもしれません。。。

static呼び出し

次のような感じです、System.out.println("XXX");

この処理の内訳を解説すると次のようになります。

Systemクラスの中にある、staticフィールド変数、out(PrintStream型)のメソッドprintln()を呼び出している

フィールド変数が直接呼び出せるのは「public」かつ「sattic」になっているからです。
具体的には下のようなコードです。

public class Sample {
    /** スタティックフィールド変数 */
    public static String publicStr = "Moring!";
    private static String privateStr = "Hello";

    public static void main(String[] args) {
        // エラーなし
        System.out.println(Sample.publicStr);
        // エラーあり、privateは外部から呼び出せない
        System.out.println(Sample.privateStr); 
    }
}

実行サンプルコードはこちらです。

それぞれ
out: 標準出力を表す「PrintStramクラス」 ※InputStreamをラップしたクラスです。
err: 「out」と同様に、「標準」エラー出力
in: 標準入力

例：

初めのプログラム「ハローワールド」では「標準出力」を使用しました。

毎度おなじみ標準出力(コンソール出力)「System.out」

System.out.println("文字列を記述");

Systemクラスのフィールド「out」を呼び出しさらに「println」メソッドを呼びます。これは改行が含まれます。

System.out.print("文字列を記述");

printlnとprintの違いです。ただしprintは、改行が含まれません。

標準入力「in」

使い方の例を示します。

一番レベルが低い状態(他のクラスでラップしない)

byte[] input = new byte[3]; // 3文字の入力を受け付ける(全角は1文字)

System.in.real(input, 0, 2); // 3文字文の領域しか用意していない

【メソッド読解】
このクラスでは全てのメソッドが「static」メソッドです。
equalsなどは「Object」(親)クラスのメソッドですので通常の、インスタンスメソッドです。

arraycopy(Object src, int srcPos, Object dest, int destPos, int length)
src: コピー元の配列を設定する
srcPos; コピーを開始する位置を指定
dest: コピー先の配列
destPos: コピー先配列の開始位置
length: コピーする数
以下は、システム・レベルで扱うプロパティなのでいじらない方が良いかも？
clearProperty(String key)
setProperty(String key, String value)
その他、よく使うのものをピックアップしました。
exit(int status): 起動しているJavaアプリケーションを終了します。
※この処理が走ると強制的に終了します。
gc(): ガベージコレクション(もう使用していないオブジェクト)を解放します。
※メモリの解放を行います。細かいことは後々。。。
そして、下のコードと同じ意味です。
```
Runtime.getRuntime().gc()
```
getenv():環境変数などの値が入っているMapが返されます。

標準入力〜標準出力を行ったプログラム＝テキストRPG(戦闘シーンのみ)を作成しましので、画像を見ると、イメージがつきやすいと思います。

JavaFX関連ページ

ステップアップ関連ページ一覧

JavaFX + ND4Jで機械学習準備

オブジェクト指向関連ページ

[オブジェクト指向の概念1〜OracleDocのチュートリアル１〜](https://zenryokuservice.com/wp/2019/10/301. /%e3%82%aa%e3%83%96%e3%82%b8%e3%82%a7%e3%82%af%e3%83%88%e6%8c%87%e5%90%91%e3%81%ae%e6%a6%82%e5%bf%b5-%e3%80%9coracledoc%e3%81%ae%e3%83%81%e3%83%a5%e3%83%bc%e3%83%88%e3%83%aa%e3%82%a2%e3%83%ab%ef%bc%91/)
オブジェクト指向の概念2〜クラスとは〜

Java Doc 読解 List 〜java.util.List その１〜

イントロダクション

自分の記憶によると、JavaDocを読まない人が多いイメージがあります。JavaAPIの使い方が書いてあるのでこれが読めればJavaを極めたといって過言ではないと思うのですが。。。

つまり、JavaDocを勧めたかったというわけです。。。

JavaDoc

JavaDocとは、作成したメソッド、クラスの説明を行うコメントです。しかし、通常のコメントと違うのは、「javadoc」コマンドを使用してJavaDocが出力できるところです。

自分の作成したものがドキュメントで一覧できれば、ちょっと嬉しいですし、実際には現場での作成してきたコードの説明などをこのJavaDocを使用して行えば、ずいぶんと学習コストが削減できると思います。つまるところは、若いエンジニアに「詠んでわからない所を聞いて」と言えるようにしておけるということです。

JavaDocを読む

Java Docの読解ということで、左のリンクはJava８のドキュメントで、Java8の概要を記述しているものになります。その中にある「java.util.List]インターフェイスクラスについて今回は読み進めてみようと思います。

リストはコレクションの仲間

コレクションフレームワーク(CollectionFramework日本語)のスーパーインターフェース(親インターフェース)にあるCollectionは
Collections Frameworkの根っこになるものです。

※スーパーインターフェース(親インターフェース)はコードに書くと下のようになります。

public interface 子供インターフェース extends 親インターフェース

このインターフェイスを実装(implements)しているクラスや継承しているインターフェイスがコレクションフレームワークの部品(クラス)になります。

ポイント

・ループ処理が楽になる
・便利なメソッドがあると思ってもらえばおっけ。
・Iteratableは「forEach」メソッドを提供します。→ラムダ式が使えるということ

List<E>のEはエレメント(要素)

を示し、ジェネリクスと呼びます。
リストなどを使用する時は大体これがもれなく付いてきます。

// ArrayListをListとして使用します。
List<String> list = new ArrayList<>();
// LinkedListをListとして使用します。
List<String> list = new LinkedList<>();
// VectorをListとして使用します。
List<String> list = new Vector<>();

上記の様に使用します。

用途としては、リストに登録した値をソート(並び替え)、指定したものの取得、リスト内にあるかチェックするなど

色々とあるので探してみるのも一興です。
百聞は一見にしかずです。ソースはこちらです。
Gitからダウンロードできます。

類似品にセット(Set)があります

toArray()はList→配列(T[])の形へ変換する

サンプルコードです。

ArrayList<TestA> list = new ArrayList<>();
for (int i = 0; i < 5; i++) {
   list.add(new TestA());
}
TestA[] items = new TestA[list.size];
items = list.toArray(items);

これで対象の型(クラス)を安全に取り出すことができます。

昔のやり方だとキャストしていましたので、コードとして美しくないし、ClassClastExceptionに対する注意が必要(安全な型変換ではない)なのでイマイチなコードでしたが、最近ではこのような方法があるのでGoodですね。

<イマイチなコード>

ArrayList<TestA> list = new ArrayList<>();
for (int i = 0; i < 5; i++) {
 list.add(new TestA());
}
// キャストしているので安全ではない
items = (TestA[]) list.toArray();

リストの主な機能

リストへの要素追加、削除、検査
ラムダ式オブジェクト取得

Collections

リストなどコレクションを扱うのに便利なクラスCollectionがあります。※以下にメソッドの一部を記載します。

Collection.addAll(): 指定されたすべての要素を指定されたコレクションに追加します。
Collection.disjoint(): 指定された2つのコレクションに共通の要素が存在しない場合、trueを返します。

List Map

Listの扱いに慣れたら、Mapインターフェースクラスも使ってみましょう。実態クラスとしては、HashMapクラス、LinkedHashMapクラスがあります。
そのほかにもありますが、今回はここまでにします。

イントロダクション

インタフェースMap<K,V>

Mapの使い方

putとget

Mapの使用例：じゃんけんゲーム

Mapの使い方：そのほか

マスターデータとのリンク

ゲームのマップを作る

関連ページ一覧

Eclipse セットアップ

Git関連

JavaFX関連ページ

ステップアップ関連ページ一覧

JavaFX + ND4Jで機械学習準備

オブジェクト指向関連ページ

イントロダクション

Systemクラスの特徴

Systemクラス

使い方

static呼び出し

例：

毎度おなじみ標準出力(コンソール出力)「System.out」

標準入力「in」

一番レベルが低い状態(他のクラスでラップしない)

関連ページ一覧

Eclipse セットアップ

Git関連

JavaFX関連ページ

ステップアップ関連ページ一覧

JavaFX + ND4Jで機械学習準備

オブジェクト指向関連ページ

イントロダクション

JavaDoc

JavaDocを読む

リストはコレクションの仲間

ポイント

List<E>のEはエレメント(要素)

toArray()はList→配列(T[])の形へ変換する

リストの主な機能

Collections

List Map

関連ページ一覧

Eclipse セットアップ

Git関連

JavaFX関連ページ