Package jmri.jmrit.logixng

Interface FemaleGenericExpressionSocket

All Superinterfaces:

Base, FemaleSocket, PropertyChangeProvider

All Known Implementing Classes:

DefaultFemaleGenericExpressionSocket

public interface FemaleGenericExpressionSocket
extends FemaleSocket

A generic female socket

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FemaleGenericExpressionSocket.SocketType

Nested classes/interfaces inherited from interface jmri.jmrit.logixng.Base

Base.PrintTreeSettings, Base.RunnableWithBase, Base.RunnableWithBaseThrowException

Field Summary

Fields inherited from interface jmri.jmrit.logixng.Base

PRINT_LINE_NUMBERS_FORMAT, PROPERTY_CHILD_COUNT, PROPERTY_CHILD_REORDER, PROPERTY_LAST_RESULT_CHANGED, PROPERTY_SOCKET_CONNECTED, PROPERTY_SOCKET_DISCONNECTED, SEPARATOR, SOCKET_CONNECTED, SOCKET_DISCONNECTED

Method Summary

Modifier and Type	Method	Description
java.lang.Object	evaluateGeneric()	Evaluate this expression.
FemaleSocket	getCurrentActiveSocket()	Get the current active socket.
FemaleGenericExpressionSocket.SocketType	getSocketType()	Get the type of the socket.
void	setSocketType(FemaleGenericExpressionSocket.SocketType socketType)	Set the type of the socket.

Methods inherited from interface jmri.jmrit.logixng.Base

addPropertyChangeListener, addPropertyChangeListener, deepCopyChildren, dispose, doSocketOperation, existsInTree, forEntireTree, forEntireTreeWithException, getCategory, getChild, getChildCount, getComment, getConditionalNG, getDeepCopy, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getLongDescription, getModule, getNumPropertyChangeListeners, getParent, getPropertyChangeListenersByReference, getRoot, getShortDescription, getShortDescription, getSystemName, getUsageDetail, getUsageTree, getUserName, hasChild, isActive, isEnabled, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParent, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange

Methods inherited from interface jmri.jmrit.logixng.FemaleSocket

canDisconnect, connect, disconnect, doSocketOperation, getConnectableClasses, getConnectedSocket, getEnableListeners, getName, isAncestor, isCompatible, isConnected, isSocketOperationAllowed, setEnableListeners, setName, setName, setup, validateName, validateName

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

getCurrentActiveSocket

FemaleSocket getCurrentActiveSocket()

Get the current active socket.

Returns:

the currently active socket or null if no socket is active

setSocketType

void setSocketType(FemaleGenericExpressionSocket.SocketType socketType)
            throws SocketAlreadyConnectedException

Set the type of the socket.

Parameters:

socketType - the type of socket.

Throws:

SocketAlreadyConnectedException - if the socket is already connected and if the new type doesn't match the currently connected socket.

getSocketType

FemaleGenericExpressionSocket.SocketType getSocketType()

Get the type of the socket.

Returns:

the type of socket

evaluateGeneric

@CheckForNull
java.lang.Object evaluateGeneric()
                          throws JmriException

Evaluate this expression.

This method validates the expression without doing any convertation of the return value.

The parameter isCompleted is used if the expression should be evaluated more than once. For example, the Count expression is not completed until its child expression has been true and false a number of times.

Returns:

the result of the evaluation. This is of the same class as parentValue.

Throws:

JmriException - when an exception occurs