org.epics.ioc.pv
Interface Field

All Known Subinterfaces:
Array, DBDRecordType, DBDStructure, Enum, Menu, Structure
All Known Implementing Classes:
ArrayBase, EnumBase, FieldBase, MenuBase, StructureBase

public interface Field

Interface for field reflection.

Author:
mrk

Method Summary
 FieldAttribute getFieldAttribute()
          Get the attribute interface for the field.
 java.lang.String getFieldName()
          Get the field name
 Property getProperty(java.lang.String propertyName)
          Get a specific property
 Property[] getPropertys()
          Get the propertys for the field.
 java.lang.String getSupportName()
          Get the name of support for this field.
 Type getType()
          Get the field type.
 boolean isMutable()
          can the data for the field be modified?
 void setMutable(boolean value)
          specify if the data for the field can be modified
 void setSupportName(java.lang.String name)
          Set the support name for this field.
 java.lang.String toString()
          convert to a string
 java.lang.String toString(int indentLevel)
          convert to a string
 

Method Detail

getFieldName

java.lang.String getFieldName()
Get the field name

Returns:
the field name

getPropertys

Property[] getPropertys()
Get the propertys for the field.

Returns:
A Property array. If null is returned then the field has no associated properties.

getProperty

Property getProperty(java.lang.String propertyName)
Get a specific property

Parameters:
propertyName - the name of the desired property
Returns:
A Property interface. This is null if propertyName is not a property of the field.

getType

Type getType()
Get the field type.

Returns:
The field type.

getSupportName

java.lang.String getSupportName()
Get the name of support for this field.

Returns:
The name of the support.

setSupportName

void setSupportName(java.lang.String name)
Set the support name for this field.

Parameters:
name - The name of the support.

isMutable

boolean isMutable()
can the data for the field be modified?

Returns:
if it can be modified

setMutable

void setMutable(boolean value)
specify if the data for the field can be modified

Parameters:
value - (false,true) if the data (can not, can) be modified

toString

java.lang.String toString()
convert to a string

Overrides:
toString in class java.lang.Object
Returns:
the field as a string

toString

java.lang.String toString(int indentLevel)
convert to a string

Parameters:
indentLevel - indentation level
Returns:
the field as a string

getFieldAttribute

FieldAttribute getFieldAttribute()
Get the attribute interface for the field.

Returns:
The FieldAttribute.