iText 8.0.5 API
Public Member Functions | Package Functions | List of all members
iText.Kernel.XMP.Options.Options Class Referenceabstract

The base class for a collection of 32 flag bits. More...

Inheritance diagram for iText.Kernel.XMP.Options.Options:
iText.Kernel.XMP.Options.AliasOptions iText.Kernel.XMP.Options.IteratorOptions iText.Kernel.XMP.Options.ParseOptions iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.SerializeOptions

Public Member Functions
  Options ()
  The default constructor. More...
 
  Options (int options)
  Constructor with the options bit mask. More...
 
virtual void  Clear ()
  Resets the options. More...
 
virtual bool  IsExactly (int optionBits)
 
virtual bool  ContainsAllOptions (int optionBits)
 
virtual bool  ContainsOneOf (int optionBits)
 
virtual void  SetOption (int optionBits, bool value)
 
virtual int  GetOptions ()
  Is friendly to access it during the tests. More...
 
virtual void  SetOptions (int options)
 
Parameters
options The options to set.

 
override bool  Equals (Object obj)
 
See also
System.Object.Equals(System.Object)

 
override int  GetHashCode ()
 
See also
System.Object.GetHashCode()

 
virtual String  GetOptionsString ()
  Creates a human readable string from the set options. More...
 
override String  ToString ()
 
Returns
Returns the options as hex bitmask.

 

Package Functions
virtual bool  GetOption (int optionBit)
 
abstract int  GetValidOptions ()
  To be implemeted by inheritants. More...
 
abstract String  DefineOptionName (int option)
  To be implemeted by inheritants. More...
 
virtual void  AssertConsistency (int options)
  The inheriting option class can do additional checks on the options. More...
 

Detailed Description

The base class for a collection of 32 flag bits.

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.

24.01.2006

Constructor & Destructor Documentation

◆ Options() [1/2]

iText.Kernel.XMP.Options.Options.Options ( )
inline

The default constructor.

◆ Options() [2/2]

iText.Kernel.XMP.Options.Options.Options ( int  options )
inline

Constructor with the options bit mask.

Parameters
options the options bit mask

Member Function Documentation

◆ AssertConsistency()

virtual void iText.Kernel.XMP.Options.Options.AssertConsistency ( int  options )
inlinepackagevirtual

The inheriting option class can do additional checks on the options.

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.

Reimplemented in iText.Kernel.XMP.Options.PropertyOptions.

◆ Clear()

virtual void iText.Kernel.XMP.Options.Options.Clear ( )
inlinevirtual

Resets the options.

◆ ContainsAllOptions()

virtual bool iText.Kernel.XMP.Options.Options.ContainsAllOptions ( int  optionBits )
inlinevirtual
Parameters
optionBits an option bitmask
Returns
Returns true, if this object contains all given options.

◆ ContainsOneOf()

virtual bool iText.Kernel.XMP.Options.Options.ContainsOneOf ( int  optionBits )
inlinevirtual
Parameters
optionBits an option bitmask
Returns
Returns true, if this object contain at least one of the given options.

◆ DefineOptionName()

abstract String iText.Kernel.XMP.Options.Options.DefineOptionName ( int  option )
packagepure virtual

To be implemeted by inheritants.

Parameters
option a single, valid option bit.
Returns
Returns a human readable name for an option bit.

Implemented in iText.Kernel.XMP.Options.SerializeOptions, iText.Kernel.XMP.Options.PropertyOptions, iText.Kernel.XMP.Options.AliasOptions, iText.Kernel.XMP.Options.ParseOptions, and iText.Kernel.XMP.Options.IteratorOptions.

◆ GetOption()

virtual bool iText.Kernel.XMP.Options.Options.GetOption ( int  optionBit )
inlinepackagevirtual
Parameters
optionBit the binary bit or bits that are requested
Returns
Returns if all of the requested bits are set or not.

◆ GetOptions()

virtual int iText.Kernel.XMP.Options.Options.GetOptions ( )
inlinevirtual

Is friendly to access it during the tests.

Returns
Returns the options.

◆ GetOptionsString()

virtual String iText.Kernel.XMP.Options.Options.GetOptionsString ( )
inlinevirtual

Creates a human readable string from the set options.

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".

◆ GetValidOptions()

abstract int iText.Kernel.XMP.Options.Options.GetValidOptions ( )
packagepure virtual

To be implemeted by inheritants.

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

Implemented in iText.Kernel.XMP.Options.SerializeOptions, iText.Kernel.XMP.Options.PropertyOptions, iText.Kernel.XMP.Options.AliasOptions, iText.Kernel.XMP.Options.ParseOptions, and iText.Kernel.XMP.Options.IteratorOptions.

◆ IsExactly()

virtual bool iText.Kernel.XMP.Options.Options.IsExactly ( int  optionBits )
inlinevirtual
Parameters
optionBits an option bitmask
Returns
Returns true, if this object is equal to the given options.

◆ SetOption()

virtual void iText.Kernel.XMP.Options.Options.SetOption ( int  optionBits,
bool  value 
)
inlinevirtual
Parameters
optionBits the binary bit or bits that shall be set to the given value
value the boolean value to set