org.jwalk
Enum Convention

java.lang.Object
  java.lang.Enum<Convention>
      org.jwalk.Convention

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Convention>

public enum Convention
extends java.lang.Enum<Convention>

Convention enumerates how many built-in methods are to be included in tests. Values include STANDARD, which excludes built-in methods from class Object; CUSTOM which includes just the four methods equals(), hashCode(), toString() and getClass(); and COMPLETE, which includes all the built-in methods from class Object.

Version:

1.0

Author:

Anthony Simons

Enum Constant Summary

COMPLETE

CUSTOM

STANDARD

Method Summary

static Convention	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Convention[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STANDARD

public static final Convention STANDARD

CUSTOM

public static final Convention CUSTOM

COMPLETE

public static final Convention COMPLETE

Method Detail

values

public static Convention[] 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 (Convention c : Convention.values())
    System.out.println(c);

Returns:

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

valueOf

public static Convention valueOf(java.lang.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.)

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

java.lang.NullPointerException - if the argument is null