org.mutabilitydetector.checkers
Enum CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult

java.lang.Object
  java.lang.Enum<CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult>
      org.mutabilitydetector.checkers.CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult

All Implemented Interfaces:

Serializable, Comparable<CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult>

Enclosing class:

CollectionTypeWrappedInUnmodifiableIdiomChecker

public static enum CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult
extends Enum<CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult>

Enum Constant Summary

DOES_NOT_WRAP_USING_WHITELISTED_METHOD

FIELD_TYPE_CANNOT_BE_WRAPPED

WRAPS_AND_COPIES_SAFELY

WRAPS_BUT_DOES_NOT_COPY

Field Summary

boolean	canBeWrapped
boolean	invokesWhitelistedWrapperMethod
boolean	safelyCopiesBeforeWrapping

Method Summary

static CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult[]	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

FIELD_TYPE_CANNOT_BE_WRAPPED

public static final CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult FIELD_TYPE_CANNOT_BE_WRAPPED

DOES_NOT_WRAP_USING_WHITELISTED_METHOD

public static final CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult DOES_NOT_WRAP_USING_WHITELISTED_METHOD

WRAPS_BUT_DOES_NOT_COPY

public static final CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult WRAPS_BUT_DOES_NOT_COPY

WRAPS_AND_COPIES_SAFELY

public static final CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult WRAPS_AND_COPIES_SAFELY

Field Detail

canBeWrapped

public final boolean canBeWrapped

invokesWhitelistedWrapperMethod

public final boolean invokesWhitelistedWrapperMethod

safelyCopiesBeforeWrapping

public final boolean safelyCopiesBeforeWrapping

Method Detail

values

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

Returns:

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

valueOf

public static CollectionTypeWrappedInUnmodifiableIdiomChecker.UnmodifiableWrapResult 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.)

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null