com.highqsoft.avalon.service.variables

Class AbstractVariable

java.lang.Object

com.highqsoft.avalon.service.variables.AbstractVariable

All Implemented Interfaces:

VariableInterface

Direct Known Subclasses:

AbstractUpdateIni, DataSizeVariable, DebuglevelVariable, MappedFilesVariable, MaxNoSessionVariable, MemoryUsageVariable, NoInstancesVariable, NoSessionVariable, ObjectUsageVariable, StatusVariable, SystemInfoVariable, UnmapFileVariable, WatchdogCountVariable

public abstract class AbstractVariable
extends java.lang.Object
implements VariableInterface

Abstract variable class.

Author:

karst

Field Summary

Fields

Modifier and Type	Field and Description
protected AoFactoryIF	aoFactory
protected AoSession	aoSession
protected java.lang.String	description
protected boolean	getable
protected java.lang.String	name
protected boolean	setable

Constructor Summary

Constructors

Constructor and Description
AbstractVariable()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	get() Get the values of the variable
boolean	getable() Is the variable a READ variable, can this variable be used in the get method.
java.lang.String	getDescription() Get the description of the variable
java.lang.String	getName() Get the name of the variable
void	set(java.lang.String value) Set the value to the variable
boolean	setable() Is the variable a WRITE variable, can this variable be used in the set method.
void	setFactory(AoFactoryIF aoFactory) Set the factory for the access to the C implementation
void	setSession(AoSession aoSession) Set the session for the access to the C implementation

Methods inherited from class java.lang.Object

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

Field Detail

getable

protected boolean getable

setable

protected boolean setable

name

protected java.lang.String name

description

protected java.lang.String description

aoFactory

protected AoFactoryIF aoFactory

aoSession

protected AoSession aoSession

Constructor Detail

AbstractVariable

public AbstractVariable()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: VariableInterface

Get the name of the variable

Specified by:

getName in interface VariableInterface

Returns:

the name

getDescription

public java.lang.String getDescription()

Description copied from interface: VariableInterface

Get the description of the variable

Specified by:

getDescription in interface VariableInterface

Returns:

the description

get

public java.lang.String[] get()
                       throws com.highqsoft.avalon.AvalonException

Description copied from interface: VariableInterface

Get the values of the variable

Specified by:

get in interface VariableInterface

Returns:

the values

Throws:

com.highqsoft.avalon.AvalonException - any occurring Avalon exception.

set

public void set(java.lang.String value)
         throws com.highqsoft.avalon.AvalonException

Description copied from interface: VariableInterface

Set the value to the variable

Specified by:

set in interface VariableInterface

Parameters:

value - the new value

Throws:

com.highqsoft.avalon.AvalonException - any occurring Avalon exception

getable

public boolean getable()
                throws com.highqsoft.avalon.AvalonException

Description copied from interface: VariableInterface

Is the variable a READ variable, can this variable be used in the get method.

Specified by:

getable in interface VariableInterface

Returns:

true when the get method can be used.

Throws:

com.highqsoft.avalon.AvalonException - any occurring Avalon exception

setable

public boolean setable()
                throws com.highqsoft.avalon.AvalonException

Description copied from interface: VariableInterface

Is the variable a WRITE variable, can this variable be used in the set method.

Specified by:

setable in interface VariableInterface

Returns:

true when the set method can be used.

Throws:

com.highqsoft.avalon.AvalonException - any occurring Avalon exception

setFactory

public void setFactory(AoFactoryIF aoFactory)

Description copied from interface: VariableInterface

Set the factory for the access to the C implementation

Specified by:

setFactory in interface VariableInterface

Parameters:

aoFactory - the com.highqsoft.avalon.AoFactory

setSession

public void setSession(AoSession aoSession)

Description copied from interface: VariableInterface

Set the session for the access to the C implementation

Specified by:

setSession in interface VariableInterface

Parameters:

aoSession - the com.highqsoft.avalon.AoSession