edu.duke

Class StorageResource

java.lang.Object

edu.duke.StorageResource

public class StorageResource
extends java.lang.Object

The StorageResource class stores any number of String objects and allows access to these stored values one at a time, using the method data. These strings can then be iterated over in the order they were added using a for loop.

This class mirrors an ArrayList<String> in some functionality, but is simpler to use and fits the Duke/Coursersa model of creating and using iterables.

Example usage:

 FileResource fr = new FileResource();
 StorageResource store = new StorageResource();
 for (String s : fr.words()) {
     store.add(s);
 }
 // can process store here, e.g.,
 // get number of strings stored
 int x = store.size();
 for (String s : store.data()) {
     // print or process s
 }
 

This software is licensed with an Apache 2 license, see http://www.apache.org/licenses/LICENSE-2.0 for details.

Constructor Summary

Constructors

Constructor and Description
StorageResource() Create an empty StorageResource object
StorageResource(StorageResource other) Create an StorageResource object that is a copy of another list.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String s) Adds a string to this storage object.
void	clear() Remove all strings from this object so that .size() == 0.
boolean	contains(java.lang.String s) Determines if a string is stored in this object.
java.lang.Iterable<java.lang.String>	data() Create and return an iterable for all strings in this object.
int	size() Returns the number of strings added/stored in this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StorageResource

public StorageResource()

Create an empty StorageResource object

StorageResource

public StorageResource(StorageResource other)

Create an StorageResource object that is a copy of another list.

Parameters:

other - the original list being copied

Method Detail

clear

public void clear()

Remove all strings from this object so that .size() == 0.

add

public void add(java.lang.String s)

Adds a string to this storage object.

Parameters:

s - the value added

size

public int size()

Returns the number of strings added/stored in this object.

Returns:

the number of strings stored in the object

contains

public boolean contains(java.lang.String s)

Determines if a string is stored in this object.

Parameters:

s - string searched for

Returns:

true if and only if s is stored in this object

data

public java.lang.Iterable<java.lang.String> data()

Create and return an iterable for all strings in this object.

Returns:

an Iterable that allows access to each string in the order stored