2次元配列の読み取りアクセスのみのインターフェースを返す方法とはどうするのでしょうか？

Question

###前提・実現したいこと
private Card[][] table_ = new Card[4][13];
カプセル化された七並べの2次元配列

これを読み取って返すのに、「読み取りアクセスのみのインターフェースを返す」方法が書籍では割愛するがあるとありました。

（１）配列をコピーArrayCopy()してその配列を返す、やり方が書いてありましたが、
この方法だと使い捨てオブジェクトを毎回生成していつかGC、ガーベジコレクションが発生する可能性があるので、回避するには「読み取りアクセスのみをインターフェースを返す」方法があるとありました。

2次元配列の読み取りアクセスのみのインターフェースを返す方法とはどうやるのでしょうか？

###発生している問題・エラーメッセージ

エラーメッセージ

###該当のソースコード

ここにご自身が実行したソースコードを書いてください

###試したこと
課題に対してアプローチしたことを記載してください

###補足情報(言語/FW/ツール等のバージョンなど)
うーんと説明が足りなかったようです。配列の一要素を取り出すのではなく、2次元配列そのものを取り出す場合なのです。
その時点でのテーブルtable_（プレイフィールド）の2次元配列を読み取って2次元配列を返すのでCard[][]を返す場合の「読み取りアクセスのみのインターフェースを返す」ということです。return table_;は好ましくないという趣旨で書かれています。”カプセル化”された配列の参照渡しはしないという意味だと思うのですがどうすればいいのでしょうか？

Answer 1

public class TableD implements Table{

	private Card[][] table_ = new Card[Card.SUIT_NUM][Card.CARD_NUM];

	boolean copyFlg = false;

	public Card[][] getCards(){
		if(copyFlg == false){
			System.arraycopy(table_[suit], 0, table[suit], 0, Card.CARD_NUM);
			copyFlg == true;
		} else {
			for(int i = 0; i < Card.SUIT_NUM; i++){
				for(int j = 0; j < Card.CARD_NUM; j++){
					table[i][j] = table_[i][j];
				}
			}
		}
		return table;
	}
}

インターフェースの方は分からないので、コピー配列を再利用する方法。

Answer 2

元の文献では、UnmodifiableCollection をつかうことを意図していると思います。

参考情報：

• Java ライブラリ -UnmodifiableCollection- http://qiita.com/y_q1m/items/6786bc79330bf9e0d908

...
Java では final の配列の要素は可変です。
...
Collections#unmodifiableList

引数で渡された List と同じ要素を持つ、変更不可の List を返すメソッドです。下記の例では Arrays#asList で一時的な List を作り、それを引数にして Collections#unmodifiableList を呼び出し、変更不可の List を取得しています。

...

Answer 3

既にある回答の焼き直しになりますが，アプローチとしては2つあります．

A. イミュータブルなリストを返す
B. 配列の一要素のみを参照できるメソッドを提供する．

これ以外の方法はありません．

【A】 java.util.Collections.unmodifiableListメソッドで，イミュータブルなリストは作れるそうです．プリミティブの配列は無理なのでリストで妥協してください．また，そのまま何も考えずに書いてしまうとメソッドを呼び出すたびにリストが作られてしまって意味が無いので，変更を加えたあとの1回目の呼び出しのみCollections.unmodifiableList()で生成するようにし，2回目以降はメンバ変数に保存しておいたものをreturnすればよいでしょう．変更を加えた時にtableChanged_の値も変更するようにしてください．

public List<List<Card>> getTable()
{
    if (tableChanged_) {
        tableCache_ = Collections.unmodifiableList(
            Stream
            .of(table_)
            .map(row -> Collections.unmodifiableList(Arrays.asList(row)))
            .collect(Collectors.toList())
        );
        tableChanged_ = false;
    }
    return tableCache_;
}

【B】 既存の回答の通り，ビュー用のメソッドを作る方法です．

Answer 4

public class TableD implements Table{

	private Card[][] table_ = new Card[Card.SUIT_NUM][Card.CARD_NUM];

	boolean copyFlg = false;

	public Card[][] getCards(){
		if(copyFlg == false){
			System.arraycopy(table_[suit], 0, table[suit], 0, Card.CARD_NUM);
			copyFlg == true;
		} else {
			for(int i = 0; i < Card.SUIT_NUM; i++){
				for(int j = 0; j < Card.CARD_NUM; j++){
					table[i][j] = table_[i][j];
				}
			}
		}
		return table;
	}
}

インターフェースの利用はできませんでしたが、
ガーベジコクレクションを回避すべく、コピー配列を再利用しました。
フラグでコピーされているか識別しました。

Comments

[mpyw]

tableが以下のいずれかを満たしていなければ「読み取り専用」になりません．

(1) メソッドの呼び出しごとに新規生成される
(2) イミュータブルである

tableを宣言している場所が見当たらないので何ともいえないのですが，もし呼び出しごとに新規生成しないのであれば，リターンされた値に変更を加えたとき，次のgetCardsの呼び出しでその変更が無効化されてしまう問題点があります．新規生成するのであれば，そもそもarraycopyとやってることが同じで実行スピードもメモリ効率も悪いです．

そこで，私やkatoyさんが提案するように，「リターンされた値に変更」することができなくなるように，イミュータブルなリストを返す方法をおすすめします．

Answer 5

その記述は、

interface ReadableMatrix {
  Card get(int x, int y);
}

なるインターフェイスを作ってその実装を返しなと言っています。
Java8ならわざわざ自分でこのインターフェイスを書かなくてもBiFunction<Integer,Integer,Card>が使えます。

だからJava8なら、BiFunction<Integer,Integer,Card>を返すことにしておいて

return (int x, int y) -> table_[x][y];

ですかね。
それとももっと古いJavaですか？

Comments

[gyro16]

`interface ReadableMatrix {
Card getCard(int suit, int number);
}
`

でこれを実装し、
`
FantanTable implements ReadableMatrix{
public Card getCard(int suit, int number){
Card card = table_[suit-1][number-1];
return card;
}
}
`
これでできます。ありがとうございました。

Answer 6

これはいわゆる「ビュー」を作るということですね。

2次元配列へのアクセスはtable_[i][j]なので、
それをメソッドでできるようにすれば良いですね。

Card getCard(int i, int j);

というメソッドだけを持ったインターフェイスを定義して、
その実装クラスにtable_を持たせるようにします。

インターフェイスがinterfaceでなく広義のを指しているなら、
クラス単体でも読み取りアクセスは実現できますね。

Comments

[gyro16]

ご返答ありがとうございます。
うーんと説明が足りなかったようです。配列の一要素を取り出すのではなく、2次元配列そのものを取り出す場合なのです。
その時点でのテーブルtable_（プレイフィールド）の2次元配列を読み取って2次元配列を返すのでCard[][]を返す場合の「読み取りアクセスのみのインターフェースを返す」ということです。return table_;は好ましくないという趣旨で書かれています。”カプセル化”された配列の参照渡しはしないという意味だと思うのですがどうすればいいのでしょうか？

[argius]

Javaで、コピー以外でかつ2次元配列そのものを読み取り専用にする方法というのは
聞いたことがありません。
List<List<Card>>型を使ってできないこともありませんが、
明示的な読み取り専用にならないので
View方式のほうが良い気がします。

ビューがCardTableViewという名前のインターフェイスだとしたら、

CardTableView view = createView(table_); // createViewはどこかで定義
Card card = view.get(3, 5); // table_[3][5]と同等、書き込みはできない

のようにできるので、
実質は2次元配列の読み取り専用と同じことになります。

1つの要素を取り出すだけでは足りなければ、
その操作をインターフェイスに追加すれば良いです。

[gyro16]

pubilc Card[][] getCards(){
//ここで返したい、本にはSystem.arraycopy()コピーした配列tableをreturnしています。
}これを「インターフェースで返す」にはどうしたらいいでしょうか？
}

[argius]

ここまでに書いたことで納得いただけないのでしたら、
ちょっとこれ以上は回答のしようがありませんね。

本当に
pubilc Card[][] getCards()
のままでインターフェイスにするなんて方法があるんでしょうか？
私も答えが知りたいです。

力及ばず申し訳ありません。

[gyro16]

七並べのテーブルなので、ゲームが進行するとtable_は更新されていきますが、table_をコピーしてその配列table一個だけを作ってgetCards()の時だけ、table_からtableに更新、追加格納してtableを返す。再利用できるコピーした配列tableはどのように書けばいいでしょうか？

[argius]

> table_からtableに更新

table_はフィールドだとして、
tableは何を表していますか？

更新はただ移し替えれば良いのでは？

[gyro16]

レスありがとうございました。
理解は深まりました。

[退会済みユーザー]

皆さんもおっしゃっていますが、Javaの配列は要素を書き換え可能だということを理解していただく必要があります。

次のようなコードを書くと、配列cards[i][j]の内容が置き換わる、つまり、table_[i][j]の内容が置き換わることになります。すると、カードゲームが正常に動作できなくなります。

Card[][] cards = x.getCards();
cards[i][j] = new Card(...);

その回避策として、getCards()が呼び出されるたびに、table_と同じ内容の新しい配列を作成しコピーして返せばよいのです。コピーですから、上のコードを実行しても、table_そのものには影響がありません。しかし、getCards()を呼び出すたびに、新しい配列を作成するため、GCが頻発しやすくなるデメリットがあります。

結局のところ、「読み取りアクセスのみのインターフェースを返す」ということは、「配列以外のモノを返しましょう」ということになるわけです。