com.itextpdf.xmp.options
Class Options

java.lang.Object
  com.itextpdf.xmp.options.Options

Direct Known Subclasses:

AliasOptions, IteratorOptions, ParseOptions, PropertyOptions, SerializeOptions

public abstract class Options
extends Object

The base class for a collection of 32 flag bits. Individual flags are defined as enum value bit masks. Inheriting classes add convenience accessor methods.

Since:

24.01.2006

Constructor Summary

Options()
The default constructor.

Options(int options)
Constructor with the options bit mask.

Method Summary

protected void	assertConsistency(int options) The inheriting option class can do additional checks on the options.
void	clear() Resets the options.
boolean	containsAllOptions(int optionBits)
boolean	containsOneOf(int optionBits)
protected abstract String	defineOptionName(int option) To be implemeted by inheritants.
boolean	equals(Object obj)
protected boolean	getOption(int optionBit)
int	getOptions() Is friendly to access it during the tests.
String	getOptionsString() Creates a human readable string from the set options.
protected abstract int	getValidOptions() To be implemeted by inheritants.
int	hashCode()
boolean	isExactly(int optionBits)
void	setOption(int optionBits, boolean value)
void	setOptions(int options)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Options

public Options()

The default constructor.

Options

public Options(int options)
        throws XMPException

Constructor with the options bit mask.

Parameters:

options - the options bit mask

Throws:

XMPException - If the options are not correct

Method Detail

clear

public void clear()

Resets the options.

isExactly

public boolean isExactly(int optionBits)

Parameters:

optionBits - an option bitmask

Returns:

Returns true, if this object is equal to the given options.

containsAllOptions

public boolean containsAllOptions(int optionBits)

Parameters:

optionBits - an option bitmask

Returns:

Returns true, if this object contains all given options.

containsOneOf

public boolean containsOneOf(int optionBits)

Parameters:

optionBits - an option bitmask

Returns:

Returns true, if this object contain at least one of the given options.

getOption

protected boolean getOption(int optionBit)

Parameters:

optionBit - the binary bit or bits that are requested

Returns:

Returns if all of the requested bits are set or not.

setOption

public void setOption(int optionBits,
                      boolean value)

Parameters:

optionBits - the binary bit or bits that shall be set to the given value

value - the boolean value to set

getOptions

public int getOptions()

Is friendly to access it during the tests.

Returns:

Returns the options.

setOptions

public void setOptions(int options)
                throws XMPException

Parameters:

options - The options to set.

Throws:

XMPException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

getOptionsString

public String getOptionsString()

Creates a human readable string from the set options. Note: This method is quite expensive and should only be used within tests or as

Returns:

Returns a String listing all options that are set to true by their name, like "option1 | option4".

toString

public String toString()

Overrides:

toString in class Object

Returns:

Returns the options as hex bitmask.

getValidOptions

protected abstract int getValidOptions()

To be implemeted by inheritants.

Returns:

Returns a bit mask where all valid option bits are set.

defineOptionName

protected abstract String defineOptionName(int option)

To be implemeted by inheritants.

Parameters:

option - a single, valid option bit.

Returns:

Returns a human readable name for an option bit.

assertConsistency

protected void assertConsistency(int options)
                          throws XMPException

The inheriting option class can do additional checks on the options. Note: For performance reasons this method is only called when setting bitmasks directly. When get- and set-methods are used, this method must be called manually, normally only when the Options-object has been created from a client (it has to be made public therefore).

Parameters:

options - the bitmask to check.

Throws:

XMPException - Thrown if the options are not consistent.