net.bitform.api.secure

Class SecureOptions.HeadersFootersBehaviorOption

java.lang.Object

net.bitform.api.options.BasicOption

net.bitform.api.options.EnumListOption

net.bitform.api.secure.SecureOptions.HeadersFootersBehaviorOption

All Implemented Interfaces:

Option

Enclosing class:

SecureOptions

public static class SecureOptions.HeadersFootersBehaviorOption
extends EnumListOption

Field Summary

Fields

Modifier and Type	Field and Description
static EnumOptionValue	Leave Leave the header/footer as is
static EnumOptionValue	Replace Replace the text of the header/footer
static EnumOptionValue	Scrub Remove the entire header/footer
static EnumOptionValue	ScrubText Remove the header/footer text but leave other constructs like graphics and fields

Method Summary

Modifier and Type	Method and Description
static EnumOptionValue[]	getAll() Get all predefinied Behaviors
EnumOptionValue	getDefault() Gets the default value for this option.
EnumOptionValue	mapId(int id) Map a integer id to a value
EnumOptionValue	mapId(java.lang.String id) Map a string id to a value

Methods inherited from class net.bitform.api.options.BasicOption

getId, getLongDescription, getName, getShortDescription, getUid, isRequest, isResponse, toString

Methods inherited from class java.lang.Object

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

Field Detail

Leave

public static final EnumOptionValue Leave

Leave the header/footer as is

Scrub

public static final EnumOptionValue Scrub

Remove the entire header/footer

ScrubText

public static final EnumOptionValue ScrubText

Remove the header/footer text but leave other constructs like graphics and fields

Replace

public static final EnumOptionValue Replace

Replace the text of the header/footer

Method Detail

getDefault

public EnumOptionValue getDefault()

Description copied from class: EnumListOption

Gets the default value for this option.

Overrides:

getDefault in class EnumListOption

Returns:

Default value

getAll

public static EnumOptionValue[] getAll()

Get all predefinied Behaviors

Returns:

array containing all possible Behaviors

mapId

public EnumOptionValue mapId(int id)

Description copied from class: EnumListOption

Map a integer id to a value

Specified by:

mapId in class EnumListOption

Parameters:

id - The integer id of a value for this enum

Returns:

The value or null if the id cannot be mapped

mapId

public EnumOptionValue mapId(java.lang.String id)

Description copied from class: EnumListOption

Map a string id to a value

Specified by:

mapId in class EnumListOption

Parameters:

id - The sting id of a value for this enum

Returns:

The value or null if the id cannot be mapped