JSONOptions (Job Scheduler extension for BASE 1.10 API documentation)

java.lang.Object

net.sf.basedb.opengrid.config.AbstractLockable<JSONOptions>

net.sf.basedb.opengrid.json.JSONOptions

public class JSONOptions
extends AbstractLockable<JSONOptions>

Options for converting other information to JSON data.

Since:: 1.0
Author:: nicklas

Field Summary

Fields

Modifier and Type Field Description

private DbControl dc

static JSONOptions DEFAULT
Use default options.

private Set<JSONOption> options

Constructor Summary

Constructors
Constructor	Description
`JSONOptions()`	Create a new options instance.
`JSONOptions(DbControl dc)`	Create a new options instance with the possibility to access the BASE database.

Method Summary

Modifier and Type	Method	Description
`void`	`disable(JSONOption option)`	Disable the given option.
`void`	`enable(JSONOption option)`	Enable the given option.
`DbControl`	`getDbControl()`	Get a DbControl which can be used to retreive information from the BASE database.
`boolean`	`isEnabled(JSONOption option)`	Checks if the given option has been enabled.

Methods inherited from class net.sf.basedb.opengrid.config.AbstractLockable

checkLocked, checkValid, isLocked, isValid, lock

Methods inherited from class java.lang.Object

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

Field Details
- DEFAULT
  
  public static final JSONOptions DEFAULT
  
  Use default options.
- dc
  
  private final DbControl dc
- options
  
  private final Set<JSONOption> options
Constructor Details
- JSONOptions
  
  public JSONOptions()
  
  Create a new options instance.
- JSONOptions
  
  public JSONOptions(DbControl dc)
  
  Create a new options instance with the possibility to access the BASE database.
Method Details
- getDbControl
  
  public DbControl getDbControl()
  
  Get a DbControl which can be used to retreive information from the BASE database. Can be null.
- isEnabled
  
  public boolean isEnabled(JSONOption option)
  
  Checks if the given option has been enabled.
- enable
  
  public void enable(JSONOption option)
  
  Enable the given option.
  
  Throws:
  
  IllegalStateException - If this instance has been locked
- disable
  
  public void disable(JSONOption option)
  
  Disable the given option.
  
  Throws:
  
  IllegalStateException - If this instance has been locked