Package com.digimarc.dms.readers

Enum Class BaseReader.UndefinedSymbology

java.lang.Object

java.lang.Enum<BaseReader.UndefinedSymbology>

com.digimarc.dms.readers.BaseReader.UndefinedSymbology

All Implemented Interfaces:

BaseReader.Symbology, Serializable, Comparable<BaseReader.UndefinedSymbology>, Constable

Enclosing class:

BaseReader

public static enum BaseReader.UndefinedSymbology
extends Enum<BaseReader.UndefinedSymbology>
implements BaseReader.Symbology

The undefined symbology is a default value only.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Undefined	Undefined symbology.

Method Summary

Modifier and Type	Method	Description
int	addSymbology(int baseValue)
int	getBitmaskValue()
String	getName()
static BaseReader.UndefinedSymbology	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BaseReader.UndefinedSymbology[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
boolean	withinMask(int readerMask)

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Undefined

public static final BaseReader.UndefinedSymbology Undefined

Undefined symbology.

This symbology is used only as a default value. It may be returned by methods (i.e. Payload.getSymbology()), but it will not be used on its own.

Method Details

values

public static BaseReader.UndefinedSymbology[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BaseReader.UndefinedSymbology valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

@NonNull
public String getName()

Specified by:

getName in interface BaseReader.Symbology

getBitmaskValue

public int getBitmaskValue()

Specified by:

getBitmaskValue in interface BaseReader.Symbology

withinMask

public boolean withinMask(int readerMask)

Specified by:

withinMask in interface BaseReader.Symbology

addSymbology

public int addSymbology(int baseValue)

Specified by:

addSymbology in interface BaseReader.Symbology