org.electrocodeogram.cpc.core.api.provider.classification
Enum IClassificationProvider.Result

java.lang.Object
  java.lang.Enum<IClassificationProvider.Result>
      org.electrocodeogram.cpc.core.api.provider.classification.IClassificationProvider.Result

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IClassificationProvider.Result>

Enclosing interface:

IClassificationProvider

public static enum IClassificationProvider.Result
extends java.lang.Enum<IClassificationProvider.Result>

Possible results of the IClassificationProvider.classify(Type, ICloneFile, IClone, String, IClone) method.

Enum Constant Summary

ACCEPTED
The classifier classified this clone as being suitable for tracking.

ERROR
Returned if any non-recoverable error occurs during clone classification.

REJECTED
The classifier classified this clone as NOT being suitable for tracking.

Method Summary

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

ACCEPTED

public static final IClassificationProvider.Result ACCEPTED

The classifier classified this clone as being suitable for tracking.

REJECTED

public static final IClassificationProvider.Result REJECTED

The classifier classified this clone as NOT being suitable for tracking.
This clone should simply be ignored.

ERROR

public static final IClassificationProvider.Result ERROR

Returned if any non-recoverable error occurs during clone classification.
This indicates that no classification data was added to the clone.
Users of this API will usually not have to check for this condition, it can be handled similarly to ACCEPTED in most situations.

Method Detail

values

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

Returns:

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

valueOf

public static IClassificationProvider.Result 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