Immutable Lines test

[alpdog14]

So I have this method:

@Override
	public final List<Integer> lines(final String word) {
		
		if(this.getMap().containsKey(word)){
			List <Integer> lines = this.getMap().get(word);
			return lines;
		}
		else{
			//return new LinkedList<Integer>();
			return emptyList;
		}
		
	}

And I have this test:

@Test
	public void testLinesImmutable() throws Exception {
		try {
			index.lines("xyz").add(3);
			fail("lines must return an immutable list");
		} catch (Exception e) { }
		index.add("xyz", 5);
		index.add("xyz", 3);
		try {
			index.lines("xyz").add(3);
			fail("lines must return an immutable list");
		} catch (Exception e) { }
	}

I thought the lines() would become immutable by adding "final" to it but it still does not pass, can anyone help me on why this test would not pass with my method.

[Tolls]

That simply says that a child class cannot override the lines method.
You want to return an unmodifiable copy of the List...see Collections utility class.

[alpdog14]

Ok so I believe I need to use:

unmodifiableList(List<? extends T> list)
Returns an unmodifiable view of the specified list.

Can anyone help me apply this method to my, I tried to add "unmodifiableList" in my method: public List <Integer> lines(final String word) so it was:

public unmodifiableList List <Integer> lines(final String word)

but it threw back a run time error. Can anyone guide me on how to format my methods to accept a unmodifiableList on my method. Do I have to completely re-write my method.

[Tolls]

It's a method.
You call it.
You'll need to pass in the List you are currently returning (before returning it), and return the result.

You don't need to change your method signature in any way since you will still be returning a List.

[pbrockway2]

The collection framework uses the so called "decorator" pattern to provide unmodifiable collections. The details are covered in the Wrapper Implementations page of Oracle's Tutorial.

[alpdog14]

Ok so I tried to apply this:

public static <T> List<Integer> unmodifiableList(List<? extends T> emptyList) {
List <Integer> lines = (List<Integer>) emptyList;
return lines;
}

but the test still does not pass. Am I closer to solving it?

[alpdog14]

I have also tried this:

public static <T> List<Integer> unmodifiableList(List<? extends T> emptyList) {
List immutableMyList = Collections.unmodifiableList(emptyList);
return immutableMyList;
}

but still does not pass, can anyone guide me through what I am missing.

[pbrockway2]

You don't need a whole method just a simple assignment. Try

    // This is just an example
    // list can come from anywhere: a method argument, from your map etc
List<Integer> list = new ArrayList<Integer>();

    // The copy is unmodifiable
List<Integer> copy = Collections.unmodifiableList(list);

[alpdog14]

Ok so after reading above I tried this:

@Override
public List <Integer> lines(final String word) {

if(this.getMap().containsKey(word)){
List <Integer> lines = this.getMap().get(word);
return lines;
}
else{
return copy;
}

}

List<Integer> copy = Collections.unmodifiableList(emptyList);

But my test still fails, am I closer?

[alpdog14]

Ok so after reading above I tried this:

private final List <Integer> emptyList = new LinkedList<Integer>();

@Override
public List <Integer> lines(final String word) {

if(this.getMap().containsKey(word)){
List <Integer> lines = this.getMap().get(word);
return lines;
}
else{
return copy;
}

}

List<Integer> copy = Collections.unmodifiableList(emptyList);

But my test still fails, am I closer?

[pbrockway2]

@Override
    /**
     * Returns an unmodifiable list of Integers associated with a given word.  The 
     * returned list may be empty but won't be null.
     */
public final List<Integer> lines(final String word) {
		
    if(this.getMap().containsKey(word)){
        List <Integer> lines = this.getMap().get(word);
        return Collections.unmodifiableList(list);
    }
    else{
        // similar:
        // create an empty list
        // and return an unmodifiable copy of it
    }
}