org.eclipse.eavp.viz.service.connections.preferences

Class PortEntry

java.lang.Object

org.eclipse.eavp.viz.datastructures.VizObject.VizObject

org.eclipse.eavp.viz.datastructures.VizEntry

org.eclipse.eavp.viz.service.connections.preferences.PortEntry

All Implemented Interfaces:

IVizObject, IVizUpdateable

public class PortEntry
extends VizEntry

This class provides an Entry that is a "continuous" Entry with a twist: instead of the allowed values' being a range between two doubles, they are a range between two integers. The range is specified by the PortEntryContentProvider.

Author:

Jordan Deyton

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable

iComponentListener

Constructor Summary

Constructors

Constructor and Description
PortEntry(PortEntry entry) The copy constructor.
PortEntry(PortEntryContentProvider contentProvider) The default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() This operation provides a deep copy of the Entry.
boolean	equals(java.lang.Object object) This method is used to check equality between the Entry and another Entry.
int	hashCode() This operation returns the hashcode value of the Entry.
void	setContentProvider(IVizEntryContentProvider contentProvider) Overrides the parent method to enforce the rule that content providers *must* be PortEntryContentProviders.
void	setContentProvider(PortEntryContentProvider contentProvider) Sets the content provider.
boolean	setValue(java.lang.String newValue) Checks the new value before attempting to set it.

Methods inherited from class org.eclipse.eavp.viz.datastructures.VizEntry

copy, getAllowedValues, getComment, getDefaultValue, getErrorMessage, getParent, getTag, getValue, getValueType, isModified, isReady, isRequired, isSecret, setComment, setParent, setReady, setRequired, setTag, update

Methods inherited from class org.eclipse.eavp.viz.datastructures.VizObject.VizObject

copy, getDescription, getId, getName, register, setDescription, setId, setName, unregister

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable

register, unregister

Constructor Detail

PortEntry

public PortEntry(PortEntry entry)

The copy constructor.

Parameters:

entry - The other PortEntry to copy.

PortEntry

public PortEntry(PortEntryContentProvider contentProvider)

The default constructor.

Parameters:

contentProvider - The PortEntry's content provider. If null, a default content provider is used.

Method Detail

clone

public java.lang.Object clone()

Description copied from class: VizEntry

This operation provides a deep copy of the Entry.

Specified by:

clone in interface IVizObject

Overrides:

clone in class VizEntry

Returns:

A clone of the Entry.

equals

public boolean equals(java.lang.Object object)

Description copied from class: VizEntry

This method is used to check equality between the Entry and another Entry. It returns true if the Entries are equal and false if they are not.

Specified by:

equals in interface IVizObject

Overrides:

equals in class VizEntry

Parameters:

object - The Entry that should be checked for equality.

Returns:

True if the Entries are equal, false if not

See Also:

Identifiable#equals(Object otherObject)

hashCode

public int hashCode()

Description copied from class: VizEntry

This operation returns the hashcode value of the Entry.

Specified by:

hashCode in interface IVizObject

Overrides:

hashCode in class VizEntry

Returns:

The hashcode

See Also:

Identifiable#hashCode()

setContentProvider

public void setContentProvider(IVizEntryContentProvider contentProvider)

Overrides the parent method to enforce the rule that content providers *must* be PortEntryContentProviders.

Overrides:

setContentProvider in class VizEntry

Parameters:

contentProvider - The content provider.

setContentProvider

public void setContentProvider(PortEntryContentProvider contentProvider)

Sets the content provider. Resets the value to the default.

Parameters:

contentProvider - The new PortEntryContentProvider. If null, nothing is done.

setValue

public boolean setValue(java.lang.String newValue)

Checks the new value before attempting to set it. The value must be an integer that lies within the port range (inclusive) defined by its associated PortEntryContentProvider.

Overrides:

setValue in class VizEntry

Parameters:

newValue - The new value of the Entry. This value will be checked by the Entry for validity.

Returns:

True if setValue worked, false otherwise.