org.marketcetera.client.brokers

Class BrokerStatus

java.lang.Object

org.marketcetera.client.brokers.BrokerStatus

All Implemented Interfaces:

Serializable, Comparable<BrokerStatus>

public class BrokerStatus
extends Object
implements Serializable, Comparable<BrokerStatus>

The web service representation of a single broker's status.

Since:

1.0.0

Version:

$Id: BrokerStatus.java 17411 2017-04-28 14:50:38Z colin $

Author:

tlerios@marketcetera.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_HOST value which indicates no host

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BrokerStatus() Create a new BrokerStatus instance.
	BrokerStatus(String inName, BrokerID inBrokerId, boolean inLoggedOn) Create a new BrokerStatus instance.
	BrokerStatus(String inName, BrokerID inBrokerId, boolean inLoggedOn, Map<String,String> inSettings) Create a new BrokerStatus instance.
	BrokerStatus(String inName, BrokerID inBrokerId, boolean inLoggedOn, Map<String,String> inSettings, Set<BrokerAlgoSpec> inAlgoSpecs) Create a new BrokerStatus instance.
	BrokerStatus(String inName, BrokerID inBrokerId, boolean inLoggedOn, Set<BrokerAlgoSpec> inAlgoSpecs) Create a new BrokerStatus instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(BrokerStatus inO)
boolean	equals(Object obj)
Set<BrokerAlgoSpec>	getBrokerAlgos() Get the brokerAlgos value.
String	getHost() Gets the host name value.
BrokerID	getId() Get the brokerId value.
boolean	getLoggedOn() Get the loggedOn value.
String	getName() Get the name value.
int	getPort() Gets the host port value.
Map<String,String>	getSettings() Get the settings value.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_HOST

public static final String NO_HOST

value which indicates no host

See Also:

Constant Field Values

Constructor Detail

BrokerStatus

public BrokerStatus(String inName,
                    BrokerID inBrokerId,
                    boolean inLoggedOn,
                    Map<String,String> inSettings,
                    Set<BrokerAlgoSpec> inAlgoSpecs)

Create a new BrokerStatus instance.

Parameters:

inName - a String value

inBrokerId - a BrokerID value

inLoggedOn - a boolean value

inSettings - a Map<String,String> value

inAlgoSpecs - a Set<BrokerAlgoSpec> value

BrokerStatus

public BrokerStatus(String inName,
                    BrokerID inBrokerId,
                    boolean inLoggedOn,
                    Map<String,String> inSettings)

Create a new BrokerStatus instance.

Parameters:

inName - a String value

inBrokerId - a BrokerID value

inLoggedOn - a boolean value

inSettings - a Map<String,String> value

BrokerStatus

public BrokerStatus(String inName,
                    BrokerID inBrokerId,
                    boolean inLoggedOn,
                    Set<BrokerAlgoSpec> inAlgoSpecs)

Create a new BrokerStatus instance.

Parameters:

inName - a String value

inBrokerId - a BrokerID value

inLoggedOn - a boolean value

inAlgoSpecs - a Set<BrokerAlgoSpec> value

BrokerStatus

public BrokerStatus(String inName,
                    BrokerID inBrokerId,
                    boolean inLoggedOn)

Create a new BrokerStatus instance.

Parameters:

inName - a String value

inBrokerId - a BrokerID value

inLoggedOn - a boolean value

BrokerStatus

protected BrokerStatus()

Create a new BrokerStatus instance.

Method Detail

getName

public String getName()

Get the name value.

Returns:

a String value

getId

public BrokerID getId()

Get the brokerId value.

Returns:

a BrokerID value

getLoggedOn

public boolean getLoggedOn()

Get the loggedOn value.

Returns:

a boolean value

getBrokerAlgos

public Set<BrokerAlgoSpec> getBrokerAlgos()

Get the brokerAlgos value.

Returns:

a Set<BrokerAlgoSpec> value

getSettings

public Map<String,String> getSettings()

Get the settings value.

Returns:

a Map<String,String> value

getHost

public String getHost()

Gets the host name value.

Returns:

a String value

getPort

public int getPort()

Gets the host port value.

Returns:

an int value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(BrokerStatus inO)

Specified by:

compareTo in interface Comparable<BrokerStatus>