org.mc4j.ems.connection.bean.attribute
Interface EmsAttribute

All Superinterfaces:

java.lang.Comparable

public interface EmsAttribute
extends java.lang.Comparable

An MBean attribute.

Version:

$Revision: 620 $($Author: ianpspringer $ / $Date: 2010-08-02 15:03:05 -0400 (Mon, 02 Aug 2010) $)

Author:

Greg Hinkle (ghinkle@users.sourceforge.net), Apr 4, 2005

Field Summary

static java.lang.String	CONTROL_ATTRIBUTE_HISTORY Default true
static java.lang.String	CONTROL_ATTRIBUTE_HISTORY_CLASS Default CompleteValueHistory
static java.lang.String	CONTROL_ATTRIBUTE_HISTORY_DEPTH Default 1

Method Summary

void	alterValue(java.lang.Object newValue) Alters the internally stored value of this attribute.
java.lang.String	getDescription()
java.lang.String	getName()
java.lang.String	getType()
java.lang.Class	getTypeClass()
java.lang.Object	getValue() Returns the locally stored value of this attribute.
ValueHistory	getValueHistory()
int	getValueSize()
boolean	isNumericType()
boolean	isReadable() Returns true if this attribute is readable, or false if it is not.
boolean	isSupportedType()
boolean	isWritable() Returns true if this attribute is writable, or false if it is not.
java.lang.Object	refresh() Updates the local value of this attribute from the server.
void	registerAttributeChangeListener(AttributeChangeListener listener)
void	setSupportedType(boolean supportedType)
void	setValue(java.lang.Object newValue) Set the attribute's value on the server.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

CONTROL_ATTRIBUTE_HISTORY

static final java.lang.String CONTROL_ATTRIBUTE_HISTORY

Default true

See Also:

Constant Field Values

CONTROL_ATTRIBUTE_HISTORY_CLASS

static final java.lang.String CONTROL_ATTRIBUTE_HISTORY_CLASS

Default CompleteValueHistory

See Also:

Constant Field Values

CONTROL_ATTRIBUTE_HISTORY_DEPTH

static final java.lang.String CONTROL_ATTRIBUTE_HISTORY_DEPTH

Default 1

See Also:

Constant Field Values

Method Detail

registerAttributeChangeListener

void registerAttributeChangeListener(AttributeChangeListener listener)

getValue

java.lang.Object getValue()

Returns the locally stored value of this attribute. Does not ask the server for the current value.

Returns:

the locally stored value of this attribute

setValue

void setValue(java.lang.Object newValue)
              throws java.lang.Exception

Set the attribute's value on the server.

Parameters:

newValue - the value to be set

Throws:

java.lang.Exception - if there was a failure to set the attribute

alterValue

void alterValue(java.lang.Object newValue)

Alters the internally stored value of this attribute. Does not update the server value. Is intended for mass updates of attribute data via the MBean.

Parameters:

newValue - the value to be set

refresh

java.lang.Object refresh()

Updates the local value of this attribute from the server.

getValueHistory

ValueHistory getValueHistory()

Returns:

getName

java.lang.String getName()

Returns:

getType

java.lang.String getType()

Returns:

getTypeClass

java.lang.Class getTypeClass()

Returns:

isNumericType

boolean isNumericType()

Returns:

getDescription

java.lang.String getDescription()

isReadable

boolean isReadable()

Returns true if this attribute is readable, or false if it is not.

Returns:

true if this attribute is readable, or false if it is not

isWritable

boolean isWritable()

Returns true if this attribute is writable, or false if it is not.

Returns:

true if this attribute is writable, or false if it is not

isSupportedType

boolean isSupportedType()

Returns:

setSupportedType

void setSupportedType(boolean supportedType)

Parameters:

supportedType -

getValueSize

int getValueSize()

Returns: