model.definition

Class AbstractVariableDefinition

java.lang.Object

model.definition.AbstractVariableDefinition

Direct Known Subclasses:

VariableDefinitionArray, VariableDefinitionSingle

public abstract class AbstractVariableDefinition
extends java.lang.Object

VariableDefinition represents an entry in the "\check\.txt" files.

Author:

HFW410RA - Philipp Rammos

Field Summary

Fields

Modifier and Type	Field and Description
private VariableContext	context The range/context of the definition.
private DefaultValue	defaultValue Represents the default value of the definition.
private boolean	isOptionalField Represents if the definition is optional.
private boolean	isReallyOptionalField Represents if the definition is really optional (for Arrays).
private java.lang.String	name Represents the name of the definition.
private static java.lang.String	NO This attribute represents the String "no".
private Position	position position where the entry is written.
private VariableOptReference	reference Represents if the definition has an opt or not.
private AbstractVariableType	type Represents the type of the definition.

Constructor Summary

Constructors

Constructor and Description
AbstractVariableDefinition(java.lang.String name, AbstractVariableType type, boolean isOptional, boolean isReallyOptional, DefaultValue defaultValue, VariableOptReference reference, Position position) Constructor, just sets the fields.
AbstractVariableDefinition(java.lang.String name, AbstractVariableType type, boolean isOptional, boolean isReallyOptional, DefaultValue defaultValue, VariableOptReference reference, Position position, VariableContext context) Constructor, just sets the fields.

Method Summary

Modifier and Type	Method and Description
VariableContext	getContext()
DefaultValue	getDefaultValue() Returns the field defaultValue.
java.lang.String	getName() Returns the field name.
Position	getPosition() Returns the field row.
VariableOptReference	getReference() Returns the field reference.
AbstractVariableType	getType() Returns the field type.
boolean	isOptional() Returns the field isOptional.
boolean	isReallyOptional() Returns the field isOptional (Array).
boolean	isVariableActive(RouterConfiguration rc, AbstractVariableDefinition absVarDef) This method checks, if the variable active or not.
abstract java.lang.String	print() Returns the line to print.

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

Represents the name of the definition.

type

private final AbstractVariableType type

Represents the type of the definition.

isOptionalField

private final boolean isOptionalField

Represents if the definition is optional.

isReallyOptionalField

private final boolean isReallyOptionalField

Represents if the definition is really optional (for Arrays).

defaultValue

private final DefaultValue defaultValue

Represents the default value of the definition.

reference

private final VariableOptReference reference

Represents if the definition has an opt or not.

position

private final Position position

position where the entry is written.

context

private final VariableContext context

The range/context of the definition. Configuration or Ext-Skript.

NO

private static final java.lang.String NO

This attribute represents the String "no".

See Also:

Constant Field Values

Constructor Detail

AbstractVariableDefinition

public AbstractVariableDefinition(java.lang.String name,
                                  AbstractVariableType type,
                                  boolean isOptional,
                                  boolean isReallyOptional,
                                  DefaultValue defaultValue,
                                  VariableOptReference reference,
                                  Position position)

Constructor, just sets the fields.

Parameters:

name - The name of the definition

type - The type of the definition

isOptional - Represents if the definition is optional

isReallyOptional - A parameter showing the ++ in arrays

defaultValue - The default value of the definition.

reference - Represents if the definition has an opt or not.

position - The row to set.

AbstractVariableDefinition

public AbstractVariableDefinition(java.lang.String name,
                                  AbstractVariableType type,
                                  boolean isOptional,
                                  boolean isReallyOptional,
                                  DefaultValue defaultValue,
                                  VariableOptReference reference,
                                  Position position,
                                  VariableContext context)

Constructor, just sets the fields.

Parameters:

name - The name of the definition

type - The type of the definition

isOptional - Represents if the definition is optional

isReallyOptional - A parameter showing the ++ in arrays

defaultValue - The default value of the definition.

reference - Represents if the definition has an opt or not.

position - The row to set.

context - The range/context of the definition (config or ext-skript).

Method Detail

getName

public java.lang.String getName()

Returns the field name. No side effects.

Returns:

this.name

getPosition

public Position getPosition()

Returns the field row. No side effects.

Returns:

this.row

getType

public AbstractVariableType getType()

Returns the field type. No side effects.

Returns:

this.type

isOptional

public boolean isOptional()

Returns the field isOptional. No side effects.

Returns:

this.isOptional

isReallyOptional

public boolean isReallyOptional()

Returns the field isOptional (Array). No side effects.

Returns:

this.isOptional

getDefaultValue

public DefaultValue getDefaultValue()

Returns the field defaultValue. No side effects.

Returns:

this.defaultValue

getReference

public VariableOptReference getReference()

Returns the field reference. No side effects.

Returns:

this.reference

print

public abstract java.lang.String print()

Returns the line to print.

Returns:

Returns a string value, representing a line to print.

isVariableActive

public boolean isVariableActive(RouterConfiguration rc,
                                AbstractVariableDefinition absVarDef)

This method checks, if the variable active or not.

Parameters:

rc - The router configuration.

absVarDef - Represents the received variable.

Returns:

result, so true or false.

getContext

public VariableContext getContext()

Returns:

the context