Enum Dictionary

java.lang.Object

java.lang.Enum<Dictionary>

Dictionary

All Implemented Interfaces:

Serializable, Comparable<Dictionary>, Iterable<String>

public enum Dictionary
extends Enum<Dictionary>
implements Iterable<String>

A simple dictionary of lower-case English words. The dictionary is not modifiable, and only one instance of the dictionary exists.

Author:

CSE1030_W14

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE A reference to the dictionary object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(String word) Looks for the given word in the dictionary.
Iterator<String>	iterator() Return an iterator over the words in the dictionary.
static void	main(String[] args)
static Dictionary	valueOf(String name) Returns the enum constant of this type with the specified name.
static Dictionary[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final Dictionary INSTANCE

A reference to the dictionary object. Clients can obtain a reference to the dictionary object by writing:

Dictionary d = Dictionary.INSTANCE;

Method Detail

values

public static Dictionary[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Dictionary c : Dictionary.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Dictionary valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

iterator

public Iterator<String> iterator()

Return an iterator over the words in the dictionary. The iterator traverses the dictionary in lexicographically order.

Specified by:

iterator in interface Iterable<String>

See Also:

Iterable.iterator()

Returns:

an iterator that traverses the words of the dictionary in lexicographical order

contains

public boolean contains(String word)

Looks for the given word in the dictionary. The result is true if the dictionary contains word, and is false otherwise.

Parameters:

word - the word to lookup in the dictionary

Returns:

true if the dictionary contains word, false otherwise.

main

public static void main(String[] args)