com.saasquatch.jsonschemainferrer

Enum IntegerTypePreference

java.lang.Object

java.lang.Enum<IntegerTypePreference>

com.saasquatch.jsonschemainferrer.IntegerTypePreference

All Implemented Interfaces:

Serializable, Comparable<IntegerTypePreference>

public enum IntegerTypePreference
extends Enum<IntegerTypePreference>

Preference for whether the type integer should be used over number in the result schema. Note that this class is not for determining whether a single number is an integer. That is the job of the IntegerTypeCriterion.

Author:

sli

See Also:

IntegerTypeCriterion

Enum Constant Summary

Enum Constants

Enum Constant and Description
IF_ALL Use integer if and only if all the samples are integers according to the IntegerTypeCriterion.
IF_ANY Use integer if an element is an integer according to the IntegerTypeCriterion.
NEVER Never use integer.

Method Summary

Modifier and Type	Method and Description
static IntegerTypePreference	valueOf(String name) Returns the enum constant of this type with the specified name.
static IntegerTypePreference[]	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

IF_ALL

public static final IntegerTypePreference IF_ALL

Use integer if and only if all the samples are integers according to the IntegerTypeCriterion. Use number otherwise.

IF_ANY

public static final IntegerTypePreference IF_ANY

Use integer if an element is an integer according to the IntegerTypeCriterion. Note that this option allows integer and number to coexist in one (sub)schema.

NEVER

public static final IntegerTypePreference NEVER

Never use integer. Always use number instead.

Method Detail

values

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

Returns:

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

valueOf

public static IntegerTypePreference 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