org.kefirsf.bb.conf

Class Scope

java.lang.Object

org.kefirsf.bb.conf.Scope

public class Scope
extends Object

Scope definition. Scope is a set of codes which work in defined places.

Author:

Vitaliy Samolovskih aka Kefir

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_IGNORE_TEXT By default we don't ignore text outer codes.
static int	DEFAULT_MAX_VALUE
static int	DEFAULT_MIN_VALUE
static boolean	DEFAULT_STRONG By default simple text is permitted.
static String	ROOT Default name for root scope.

Constructor Summary

Constructors

Constructor and Description
Scope() Create a scope with random name.
Scope(String name) Create a scope with a name.
Scope(String name, boolean ignoreText) Create a scope.
Scope(String name, Scope parent, boolean ignoreText) Create a scope.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCode(Code code) Add a code to scope.
boolean	equals(Object o)
Set<Code>	getCodes() Get codes of scope.
int	getMax() Get the maximum count of codes which can be parsed in this scope.
int	getMin() Get the minimum count of parsed codes.
String	getName() Get scope name.
Scope	getParent() Get parent scope.
int	hashCode()
boolean	isIgnoreText() How to use text outer codes.
boolean	isStrong() If the scope is strong then only the codes from the scope can be parsed by it.
void	setCodes(Set<Code> codes) Set codes.
void	setIgnoreText(boolean ignoreText) How to use text outer codes.
void	setMax(int max) Set the maximum count of codes which can be parsed in this scope.
void	setMin(int min) Set the minimum count of parsed codes.
void	setName(String name) Set scope name
void	setParent(Scope parent) Set parent scope.
void	setStrong(boolean strong) If the scope is strong then only the codes from the scope can be parsed by it.

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

public static final String ROOT

Default name for root scope. If ROOT scope not defined in configuration then all codes add to default ROOT scope.

See Also:

Constant Field Values

DEFAULT_IGNORE_TEXT

public static final boolean DEFAULT_IGNORE_TEXT

By default we don't ignore text outer codes.

See Also:

Constant Field Values

DEFAULT_STRONG

public static final boolean DEFAULT_STRONG

By default simple text is permitted.

See Also:

Constant Field Values

DEFAULT_MAX_VALUE

public static final int DEFAULT_MAX_VALUE

See Also:

Constant Field Values

DEFAULT_MIN_VALUE

public static final int DEFAULT_MIN_VALUE

See Also:

Constant Field Values

Constructor Detail

Scope

public Scope()

Create a scope with random name.

Scope

public Scope(String name)

Create a scope with a name.

Parameters:

name - name of scope

Scope

public Scope(String name,
     boolean ignoreText)

Create a scope.

Parameters:

name - scope name

ignoreText - define ignore or not text outer the codes.

Scope

public Scope(String name,
     Scope parent,
     boolean ignoreText)

Create a scope.

Parameters:

name - scope name

parent - parent scope

ignoreText - define copy or not text outer the codes.

Method Detail

getName

public String getName()

Get scope name.

Returns:

scope name

setName

public void setName(String name)

Set scope name

Parameters:

name - new scope name

getParent

public Scope getParent()

Get parent scope. The scope inherit all codes from parent.

Returns:

scope

setParent

public void setParent(Scope parent)

Set parent scope. The scope inherit all codes from parent.

Parameters:

parent - scope

isStrong

public boolean isStrong()

If the scope is strong then only the codes from the scope can be parsed by it.

Returns:

true if the scope is strong, false otherwise

setStrong

public void setStrong(boolean strong)

If the scope is strong then only the codes from the scope can be parsed by it.

Parameters:

strong - true if the scope is strong, false otherwise

isIgnoreText

public boolean isIgnoreText()

How to use text outer codes.

Returns:

true ignore text false copy, default

setIgnoreText

public void setIgnoreText(boolean ignoreText)

How to use text outer codes.

Parameters:

ignoreText - true - ignore text, false - copy. By default is false.

getCodes

public Set<Code> getCodes()

Get codes of scope. Only of this scope not of parent.

Returns:

code set

setCodes

public void setCodes(Set<Code> codes)

Set codes.

Parameters:

codes - set of codes

addCode

public void addCode(Code code)

Add a code to scope.

Parameters:

code - code

getMin

public int getMin()

Get the minimum count of parsed codes.

Returns:

minimum

setMin

public void setMin(int min)

Set the minimum count of parsed codes.

Parameters:

min - minimum

getMax

public int getMax()

Get the maximum count of codes which can be parsed in this scope.

Returns:

maximum

setMax

public void setMax(int max)

Set the maximum count of codes which can be parsed in this scope.

Parameters:

max - maximum

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object