addで追加したいがエラーがでてしまう。

Question

addで情報を加えたいのですが、addを加えるとエラーが出てしまいます。
maxSize を超えた分古いデータは削除の部分のif文の条件式にlengthやsizeを使ったところエラーがでてしまい、どう文字列の長さを表現すればよいかわかりません

実行したい内容
add 'Java'
=> [Java]
add 'Python'
=> [Java, Python]
add ''
add ''
add 'JavaScript'
=> [Java, Python, JavaScript]
add 'Go'
=> [Python, JavaScript, Go]
add 'Swift'
=> [JavaScript, Go, Swift]
add 'Go'
=> [JavaScript, Swift, Go]
add 'Rust'
=> [Swift, Go, Rust]

現状の実行結果
Exception in thread "main" java.lang.StackOverflowError
at java.base/java.lang.String.equals(String.java:1009)
at ex5.SearchHistory.add(SearchHistory.java:25)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)

コード
package ex5;

import java.util.ArrayDeque;
import java.util.Queue;

public class SearchHistory extends ArrayDeque<String> {
    private int maxSize;

    public SearchHistory(int maxSize) {
        // TODO: 初期化
    	this.maxSize=maxSize;
    }

    /**
     * word を追加する。空文字の場合は追加しない。
     * すでに入っていた文字は入れ直す。
     * maxSize を超えた分古いデータは削除
     *
     * @param word
     * @return 追加したか否か
     */
    @Override
    public boolean add(String word) {
        // TODO: 空文字は保存せず false を返す
    	if (word.equals("")) {
    		return false;
    	} else {
    		add(word);
    	}
        // TODO: すでに入っている文字は入れ直す
    	if (word.contains(word)) {
    		remove(word);
    		add(word);
    	}
        // TODO: maxSize を超えた分古いデータは削除
    	if (word.length<=maxSize) {
    		remove(word[0]);
    	}
        return true;
    }

    public static void main(String[] args) {
        Queue<String> queue = new SearchHistory(3);

        String[] orders = new String[]{"Java", "Python", "", "", "JavaScript", "Go", "Swift", "Go", "Rust"};
        for (String s : orders) {
            boolean added = queue.add(s);
            System.out.println("add '" + s + "'");
            if (added) {
                System.out.println(" => " + queue);
            }
        }
    }
}

Answer 1

まずエラーメッセージぐらい読みましょう。
エラーメッセージは怒声でも罵倒でもありません。
コンパイラ等からのメッセージです。

Exception in thread "main"
java.lang.StackOverflowError
at java.base/java.lang.String.equals(String.java:1009)
at ex5.SearchHistory.add(SearchHistory.java:25)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)
at ex5.SearchHistory.add(SearchHistory.java:28)

[訳]
“main”スレッドにて、例外発生！
java.lang.StackOverflowError
という例外が発生しました！
場所はSearchHistory.javaの28行目、
ex5.SearchHistory.addメソッド内の、
java.base/java.lang.String.equalsメソッドです。

java.lang.StackOverflowErrorは『例外』です。公式で調べると、『スタックオーバーフローが起きているのが原因』のようです。

とりあえず、例外が飛んできている場所を調べましょう。

すると、

    @Override
    public boolean add(String word) {
        if (word.equals("")) { // <= ここ！
            return false;
        } else {
            add(word);
        }
        
        if (word.contains(word)) {
            remove(word);
            add(word);
        }
        
        if (word.length<=maxSize) {
            remove(word[0]);
        }
        return true;
    }

のようです。

単純に見れば、問題なさそうですが、相当やらかしています。

次に、コードを読みましょう。

コードを読むコツは、『一行レベルで、その行が何をしているのかを考えながら読む』です。

    // メソッドをオーバーライドする
    @Override
    public boolean add(String word) {
        // 引数が空ならfalseを返すだけ
        if (word.equals("")) { // <= ここ！
            return false;
         // それ以外(空以外)なら
        } else {
             // 自身を『再帰的に』呼び出す
            add(word);
        }
        
        // 引数に引数が含まれているのなら
        if (word.contains(word)) {
            // removeメソッドで削除
            remove(word);
            // 自身を『再帰的に』呼び出す
            add(word);
        }
        
        if (word.length<=maxSize) {
            remove(word[0]);
        }
        return true;
    }

後半は面倒なので端折りましたが、こういう風にやってみる。
(今回は関係がないので端折りました)

そしてこのコメントを抽出し、擬似コードとして書く。

0. メソッドaddとし、引数はwordとする
1. wordが空なら
    1.1. falseを返して終了
2. それ以外(空以外)なら
     2.1. 自身を『再帰的に』呼び出す
3. wordにwordが含まれているのなら
     3.1. 自分のremoveメソッドでwordを削除
     3.2. …
…

のような感じですね。

これを現実世界でシミュレーションしてみてください。
つまり、数学なり料理のレシピなりの手順だと考えて、手作業でやってみてください。

実際にwordに値を入れてみるとかです。

そうすると、おかしなことに気付きますね。

仮にword: が空なら(1)を満たすので(1.1)でfalseを返して終了します。

ですが、wordが空以外だとどうなるでしょうか。

たとえば、

word: “Hello”

とかです。

(1)を満たしませんから、(2)にいきます。
で強制的に(2.1)に行き、自身を再帰的に呼び出します。
つまり、(0)に移動します。

でもwordはいつまで経っても値が変わっていないので無限に回り続け、果てにはスタックオーバーフローを起こします。

これが今回の原因です。

たぶんですが、(2.1)では『親の』addメソッドを呼び出したいのでしょうけど、これでは自分自身しか呼び出しません。

ヒント: 参考1

他にもいろいろおかしいところがありますが、オフトピになるので。

そもそも、ロジックそのものがおかしいです。

プログラミングっていうのは『こう書けばいい』というものではありません。

『プログラミングは現実世界のシミュレーション』です。

[質問者さんが学ぶべきこと]
■ ポリモーフィズム関係
■ スタック領域とヒープ領域
■ プログラミングとは何か
■ エラーメッセージや例外メッセージを読んで対処すること
■ ロジックの基本的な考え方
■ コードを読むこと

Comments

[8Hachikou8]

丁寧にありがとうございます。ヒントを参考にやってみます

Answer 2

空文字以外だと、addが無限に再帰呼び出しされてます

Comments

[8Hachikou8]

1度だけ呼び出したい場合はどのようにすればよいでしょうか。
else {
return true;
}
とするとほかのところがエラーになってしまって