Enum Class CollectionMethods

java.lang.Object

java.lang.Enum<CollectionMethods>

org.soliscode.test.contract.CollectionMethods

All Implemented Interfaces:

Serializable, Comparable<CollectionMethods>, Constable, OptionalMethod

public enum CollectionMethods
extends Enum<CollectionMethods>
implements OptionalMethod

Values used to identify collection class methods for use with the CollectionContract.supportsMethod(OptionalMethod) method.

Since:

1.0

Author:

evanbergstrom

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Add	The option al method Collection.add(Object).
AddAll	The option al method Collection.addAll(Collection).
AddAllAtIndex	The option al method List.addAll(int, Collection).
AddAtIndex	The optional method List.add(int, java.lang.Object).
AddFirst	The option al method SequencedCollection.addFirst(Object).
AddLast	The optional method SequencedCollection.addLast(Object).
Clear	The option al method Collection.clear().
ContainsAll	The option al method Collection.containsAll(Collection).
Get	The method List.get(int).
GetFirst	The method SequencedCollection.getFirst().
GetLast	The method SequencedCollection.getLast().
IteratorForEachRemaining	The option al method Iterator.forEachRemaining(Consumer).
IteratorRemove	The optional method Iterator.remove().
Remove	The optional method Collection.remove(Object).
RemoveAll	The optional method Collection.removeAll(Collection).
RemoveAtIndex	The optional method List.remove(int).
RemoveFirst	The option al method SequencedCollection.removeFirst().
RemoveIf	The optional method Collection.removeIf(Predicate).
RemoveLast	The option al method SequencedCollection.removeLast().
ReplaceAll	The option al method List.replaceAll(UnaryOperator).
RetainAll	The optional method Collection.retainAll(Collection).
Reversed	The method SequencedCollection.reversed().
Set	The optional method List.set(int, E).
Sort	The optional method List.sort(java.util.Comparator<? super E>).
Stream	The method Collection.stream().

Method Summary

Modifier and Type	Method	Description
static CollectionMethods	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CollectionMethods[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Add

public static final CollectionMethods Add

The option al method Collection.add(Object).

AddAll

public static final CollectionMethods AddAll

The option al method Collection.addAll(Collection).

AddAllAtIndex

public static final CollectionMethods AddAllAtIndex

The option al method List.addAll(int, Collection).

AddAtIndex

public static final CollectionMethods AddAtIndex

The optional method List.add(int, java.lang.Object).

AddFirst

public static final CollectionMethods AddFirst

The option al method SequencedCollection.addFirst(Object).

AddLast

public static final CollectionMethods AddLast

The optional method SequencedCollection.addLast(Object).

Clear

public static final CollectionMethods Clear

The option al method Collection.clear().

ContainsAll

public static final CollectionMethods ContainsAll

The option al method Collection.containsAll(Collection).

Get

public static final CollectionMethods Get

The method List.get(int).

GetFirst

public static final CollectionMethods GetFirst

The method SequencedCollection.getFirst().

GetLast

public static final CollectionMethods GetLast

The method SequencedCollection.getLast().

IteratorForEachRemaining

public static final CollectionMethods IteratorForEachRemaining

The option al method Iterator.forEachRemaining(Consumer).

IteratorRemove

public static final CollectionMethods IteratorRemove

The optional method Iterator.remove().

Remove

public static final CollectionMethods Remove

The optional method Collection.remove(Object).

RemoveAll

public static final CollectionMethods RemoveAll

The optional method Collection.removeAll(Collection).

RemoveAtIndex

public static final CollectionMethods RemoveAtIndex

The optional method List.remove(int).

RemoveFirst

public static final CollectionMethods RemoveFirst

The option al method SequencedCollection.removeFirst().

RemoveIf

public static final CollectionMethods RemoveIf

The optional method Collection.removeIf(Predicate).

RemoveLast

public static final CollectionMethods RemoveLast

The option al method SequencedCollection.removeLast().

ReplaceAll

public static final CollectionMethods ReplaceAll

The option al method List.replaceAll(UnaryOperator).

RetainAll

public static final CollectionMethods RetainAll

The optional method Collection.retainAll(Collection).

Reversed

public static final CollectionMethods Reversed

The method SequencedCollection.reversed().

Set

public static final CollectionMethods Set

The optional method List.set(int, E).

Sort

public static final CollectionMethods Sort

The optional method List.sort(java.util.Comparator<? super E>).

Stream

public static final CollectionMethods Stream

The method Collection.stream().

Method Details

values

public static CollectionMethods[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CollectionMethods valueOf(String name)

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

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null