State (J2SSH Javadocs)

java.lang.Object

com.sshtools.j2ssh.util.State

All Implemented Interfaces:: Serializable

Direct Known Subclasses:: ChannelState, IOStreamConnectorState, OpenClosedState, ServiceState, StartStopState, TransportProtocolState

public abstract class State extends Object implements Serializable

Version:

$Revision: 1.18 $

Author:

$author$

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

protected int

state
Constructor Summary

Constructors

Constructor

Description

State(int initialState)

Creates a new State object.
Method Summary

Modifier and Type

Method

Description

void

breakWaiting()

int

getValue()

abstract boolean

isValidState(int state)

void

setValue(int state)

boolean

waitForState(int state)

boolean

waitForState(int state, long timeout)

int

waitForStateUpdate()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- state
  
  protected int state
Constructor Details
- State
  
  public State(int initialState)
  
  Creates a new State object.
  
  Parameters:
  
  initialState -
Method Details
- isValidState
  
  public abstract boolean isValidState(int state)
  
  Parameters:
  
  state -
  
  Returns:
- setValue
  
  public void setValue(int state) throws InvalidStateException
  
  Parameters:
  
  state -
  
  Throws:
  
  InvalidStateException
- getValue
  
  public int getValue()
  
  Returns:
- breakWaiting
  
  public void breakWaiting()
- waitForState
  
  public boolean waitForState(int state) throws InvalidStateException, InterruptedException
  
  Parameters:
  
  state -
  
  Returns:
  
  Throws:
  
  InvalidStateException
  
  InterruptedException
- waitForState
  
  public boolean waitForState(int state, long timeout) throws InvalidStateException, InterruptedException
  
  Parameters:
  
  state -
  
  timeout -
  
  Returns:
  
  Throws:
  
  InvalidStateException
  
  InterruptedException
- waitForStateUpdate
  
  public int waitForStateUpdate() throws InterruptedException
  
  Returns:
  
  Throws:
  
  InterruptedException