Package com.digimarc.dms.readers

Class ReaderOptionsExtended

java.lang.Object

com.digimarc.dms.readers.ReaderOptions

com.digimarc.dms.readers.ReaderOptionsExtended

public class ReaderOptionsExtended
extends ReaderOptions

ReaderOptionsExtended allows private channels to be configured. This class is not needed in most use cases.

Private channels are a way to segment specific types of data from Digimarc Barcode applications. This is an optional feature not needed by most applications. Please contact Digimarc if you have a business application that requires segmented, proprietary data.

Field Summary

Fields inherited from class com.digimarc.dms.readers.ReaderOptions

Distance_Far, Distance_FullRange, Distance_Near, EnableImageFrameStorage, EnablePlasticsReading, InvertedBarcodeInterval, ITF_BarcodeMinLength, TraditionalBarcodeReadDistance

Constructor Summary

Constructors

Constructor	Description
ReaderOptionsExtended()

Method Summary

Modifier and Type	Method	Description
Set<String>	getKeys()	Get the key set from the ReaderOptionsExtended object.
byte[]	getValueBytes(String channelName)	Get the value associated with a given private channel.
static byte[]	isOptionSet(ReaderOptionsExtended options, String optionName)	Checks the provided options dictionary for the specified name-value pair.
void	setValue(String key, byte[] value)	Stores a key value pair in the options dictionary.

Methods inherited from class com.digimarc.dms.readers.ReaderOptions

getIntegerValue, getStringValue, getValue, isOptionPresent, isOptionSet, setValue, setValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReaderOptionsExtended

public ReaderOptionsExtended()

Method Details

getValueBytes

@Nullable
public byte[] getValueBytes(@NonNull
 String channelName)

Get the value associated with a given private channel.

Parameters:

channelName - Channel name to search for.

Returns:

Value associated with the channelName or null if the channelName is not present.

setValue

public void setValue(@NonNull
 String key,
 @NonNull
 byte[] value)

Stores a key value pair in the options dictionary.

Parameters:

key - Key

value - Value

isOptionSet

@Nullable
public static byte[] isOptionSet(@Nullable
 ReaderOptionsExtended options,
 @NonNull
 String optionName)

Checks the provided options dictionary for the specified name-value pair.

Parameters:

options - Options dictionary.

optionName - Options value name to lookup

Returns:

Was the named value present?

getKeys

@NonNull
public Set<String> getKeys()

Get the key set from the ReaderOptionsExtended object.

Overrides:

getKeys in class ReaderOptions

Returns:

Set of Strings containing all of the available keys.