org.datavec.api.writable

Enum WritableType

java.lang.Object

java.lang.Enum<WritableType>

org.datavec.api.writable.WritableType

All Implemented Interfaces:

Serializable, Comparable<WritableType>

public enum WritableType
extends Enum<WritableType>

Created by Alex on 30/05/2017.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Boolean
Byte
Double
Float
Image
Int
Long
NDArray
Null
Text

Method Summary

Modifier and Type	Method and Description
Class<? extends Writable>	getWritableClass() Return the class of the implementation corresponding to each WritableType.
boolean	isCoreWritable()
short	typeIdx() Return a unique type index for the given writable
static WritableType	valueOf(String name) Returns the enum constant of this type with the specified name.
static WritableType[]	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

Boolean

public static final WritableType Boolean

Byte

public static final WritableType Byte

Double

public static final WritableType Double

Float

public static final WritableType Float

Int

public static final WritableType Int

Long

public static final WritableType Long

Null

public static final WritableType Null

Text

public static final WritableType Text

NDArray

public static final WritableType NDArray

Image

public static final WritableType Image

Method Detail

values

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

Returns:

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

valueOf

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

isCoreWritable

public boolean isCoreWritable()

Returns:

True if Writable is defined in datavec-api, false otherwise

typeIdx

public short typeIdx()

Return a unique type index for the given writable

Returns:

Type index for the writable

getWritableClass

public Class<? extends Writable> getWritableClass()

Return the class of the implementation corresponding to each WritableType. Note that if isCoreWritable() returns false, null will be returned by this method.

Returns:

Class for the given WritableType