com.github.dandelion.datatables.core.option

Class Option<T>

java.lang.Object

com.github.dandelion.datatables.core.option.Option<T>

Type Parameters:

T - Type of the option, crucial for the JavaScript generation. See DatatableConfigGenerator.

All Implemented Interfaces:

Comparable<Option<T>>

public class Option<T>
extends Object
implements Comparable<Option<T>>

Representation of a component option, which is used to configure different aspects of a component.

Each Option is composed of:

• a uniq name, which may be used in configuration properties
• an associated OptionProcessor which indicates how the value of the option should be processed
• a precedence to indicate if the Option should be processed before another one

Options are registered in multiple ways:

• Using one or more properties files
• Using a JSP taglib
• Using a Thymeleaf dialect
• Using the API

Options are usually stored in Map structures, such as Map<Option<?>, Object> where Object is the value of the option.

Since:

1.0.0

Author:

Thibault Duchateau

See Also:

OptionProcessor

Constructor Summary

Constructors

Constructor and Description
Option(String name, OptionProcessor processor, int precedence)

Method Summary

Methods

Modifier and Type	Method and Description
void	appendIn(ColumnConfiguration columnConfiguration, char value)
void	appendIn(ColumnConfiguration columnConfiguration, String value)
void	appendIn(TableConfiguration tableConfiguration, char value)
void	appendIn(TableConfiguration tableConfiguration, String value)
int	compareTo(Option<T> o) Compare options according to their precedence.
boolean	equals(Object obj)
String	getName()
int	getPrecedence()
OptionProcessor	getProcessor()
String	getUserName()
int	hashCode()
void	setIn(ColumnConfiguration columnConfiguration, T value)
void	setIn(TableConfiguration tableConfiguration, T value)
void	setIn(T value, HtmlTable table)
void	setUserName(String userName) TODO
String	toString()
T	valueFrom(ColumnConfiguration columnConfiguration)
T	valueFrom(HtmlTable table)
T	valueFrom(Map<Option<?>,Object> configurations)
T	valueFrom(TableConfiguration tableConfiguration)

Methods inherited from class java.lang.Object

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

Constructor Detail

Option

public Option(String name,
      OptionProcessor processor,
      int precedence)

Parameters:

name -

processor -

precedence -

Method Detail

getName

public String getName()

Returns:

the name of the option.

getUserName

public String getUserName()

Returns:

the optional user-defined name of the option.

setUserName

public void setUserName(String userName)

TODO

Parameters:

userName -

getProcessor

public OptionProcessor getProcessor()

Returns:

the OptionProcessor to be applied on the value associated with the option.

getPrecedence

public int getPrecedence()

Returns:

the precedence of the option.

valueFrom

public T valueFrom(Map<Option<?>,Object> configurations)

valueFrom

public T valueFrom(TableConfiguration tableConfiguration)

valueFrom

public T valueFrom(ColumnConfiguration columnConfiguration)

valueFrom

public T valueFrom(HtmlTable table)

setIn

public void setIn(ColumnConfiguration columnConfiguration,
         T value)

setIn

public void setIn(TableConfiguration tableConfiguration,
         T value)

appendIn

public void appendIn(TableConfiguration tableConfiguration,
            String value)

appendIn

public void appendIn(TableConfiguration tableConfiguration,
            char value)

appendIn

public void appendIn(ColumnConfiguration columnConfiguration,
            String value)

appendIn

public void appendIn(ColumnConfiguration columnConfiguration,
            char value)

setIn

public void setIn(T value,
         HtmlTable table)

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Option<T> o)

Compare options according to their precedence.

Be careful: This implementation of compareTo breaks (o1.compareTo(o2) == 0) == (o1.equals(o2)), as two different options can have the same precedence.

Specified by:

compareTo in interface Comparable<Option<T>>

Parameters:

o - the object to compare to

Returns:

the comparison result.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object