org.kefirsf.bb.conf

Class Code

java.lang.Object

org.kefirsf.bb.conf.Code

public class Code
extends Object

Code description.

Author:

Vitaliy Samolovskih aka Kefir

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
Code() Construct code definition with random name and default priority.
Code(Pattern pattern, Template template, String name, int priority) Create code definition.
Code(String name) Construct code definition with name and default priority.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPattern(Pattern pattern) Add a pattern to the list of patterns.
boolean	equals(Object o)
String	getName() Get a code name.
Pattern	getPattern() Deprecated.
List<Pattern>	getPatterns() A code contains collection of patterns for parsing.
int	getPriority() Get the code priority.
Template	getTemplate() Get template for text generation.
int	hashCode()
boolean	hasPatterns() Check if the code has patterns.
boolean	isTransparent() If the code is transparent, then all variables which were set on the code processing will be accessible from other codes from on the same context, the same indentation level.
void	setName(String name) Set a code name.
void	setPattern(Pattern pattern) Deprecated.
void	setPatterns(List<Pattern> patterns) Set the patterns list.
void	setPriority(int priority) Set the code priority.
void	setTemplate(Template template) Set template for text generation
void	setTransparent(boolean transparent) If the code is transparent, then all variables which were set on the code processing will be accessible from other codes from on the same context, the same indentation level.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

Constructor Detail

Code

public Code()

Construct code definition with random name and default priority.

Code

public Code(String name)

Construct code definition with name and default priority.

Parameters:

name - code name

Code

public Code(Pattern pattern,
    Template template,
    String name,
    int priority)

Create code definition.

Parameters:

pattern - text pattern for parsing

template - text generation template

name - code name

priority - code priority

Method Detail

getName

public String getName()

Get a code name.

Returns:

name of code

setName

public void setName(String name)

Set a code name.

Parameters:

name - code name

getPriority

public int getPriority()

Get the code priority. By default it is 0. Greater has bigger priority.

Returns:

code priority

setPriority

public void setPriority(int priority)

Set the code priority. By default it is 0. Greater has bigger priority.

Parameters:

priority - code priority

getPatterns

public List<Pattern> getPatterns()

A code contains collection of patterns for parsing. One or more. A code tries to parse by all patterns from first to last.

Returns:

the list of patterns of the code

setPatterns

public void setPatterns(List<Pattern> patterns)

Set the patterns list. A code contains collection of patterns for parsing. One or more. A code tries to parse by all patterns from first to last.

Parameters:

patterns - the list of patterns

addPattern

public void addPattern(Pattern pattern)

Add a pattern to the list of patterns.

Parameters:

pattern - a pattern

hasPatterns

public boolean hasPatterns()

Check if the code has patterns.

Returns:

true if the code has one or more patterns, false otherwise

getPattern

@Deprecated
public Pattern getPattern()

Deprecated.

Get pattern for text parsing

Returns:

pattern definition object

setPattern

@Deprecated
public void setPattern(Pattern pattern)

Deprecated.

Set pattern for text parsing

Parameters:

pattern - pattern definition object

getTemplate

public Template getTemplate()

Get template for text generation.

Returns:

template definition object

setTemplate

public void setTemplate(Template template)

Set template for text generation

Parameters:

template - template definition object

isTransparent

public boolean isTransparent()

If the code is transparent, then all variables which were set on the code processing will be accessible from other codes from on the same context, the same indentation level.

Returns:

true if the code is transparent, false otherwise

setTransparent

public void setTransparent(boolean transparent)

If the code is transparent, then all variables which were set on the code processing will be accessible from other codes from on the same context, the same indentation level.

Parameters:

transparent - true for transparent

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object