org.marketcetera.client.brokers.BrokerStatus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of client Show documentation
There is a newer version: 3.2.1
package org.marketcetera.client.brokers;

import java.io.Serializable;
import java.util.Map;
import java.util.Set;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;

import org.marketcetera.algo.BrokerAlgoSpec;
import org.marketcetera.trade.BrokerID;
import org.marketcetera.util.misc.ClassVersion;

/* $License$ */

/**
 * The web service representation of a single broker's status.
 *
 * @author [email protected]
 * @since 1.0.0
 * @version $Id: BrokerStatus.java 16947 2014-09-25 20:27:42Z colin $
 */
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
@ClassVersion("$Id: BrokerStatus.java 16947 2014-09-25 20:27:42Z colin $")
public class BrokerStatus
        implements Serializable
{
    /**
     * Create a new BrokerStatus instance.
     *
     * @param inName a String value
     * @param inBrokerId a BrokerID value
     * @param inLoggedOn a boolean value
     * @param inSettings a Map<String,String> value
     * @param inAlgoSpecs a Set<BrokerAlgoSpec> value
     */
    public BrokerStatus(String inName,
                        BrokerID inBrokerId,
                        boolean inLoggedOn,
                        Map inSettings,
                        Set inAlgoSpecs)
    {
        name = inName;
        brokerId = inBrokerId;
        loggedOn = inLoggedOn;
        settings = inSettings;
        brokerAlgos = inAlgoSpecs;
    }
    /**
     * Create a new BrokerStatus instance.
     *
     * @param inName a String value
     * @param inBrokerId a BrokerID value
     * @param inLoggedOn a boolean value
     * @param inSettings a Map<String,String> value
     */
    public BrokerStatus(String inName,
                        BrokerID inBrokerId,
                        boolean inLoggedOn,
                        Map inSettings)
    {
        this(inName,
             inBrokerId,
             inLoggedOn,
             inSettings,
             null);
    }
    /**
     * Create a new BrokerStatus instance.
     *
     * @param inName a String value
     * @param inBrokerId a BrokerID value
     * @param inLoggedOn a boolean value
     * @param inAlgoSpecs a Set<BrokerAlgoSpec> value
     */
    public BrokerStatus(String inName,
                        BrokerID inBrokerId,
                        boolean inLoggedOn,
                        Set inAlgoSpecs)
    {
        this(inName,
             inBrokerId,
             inLoggedOn,
             null,
             inAlgoSpecs);
    }
    /**
     * Create a new BrokerStatus instance.
     *
     * @param inName a String value
     * @param inBrokerId a BrokerID value
     * @param inLoggedOn a boolean value
     */
    public BrokerStatus(String inName,
                        BrokerID inBrokerId,
                        boolean inLoggedOn)
    {
        this(inName,
             inBrokerId,
             inLoggedOn,
             null,
             null);
    }
    /**
     * Create a new BrokerStatus instance.
     */
    @SuppressWarnings("unused")
    private BrokerStatus()
    {
        name = null;
        brokerId = null;
        loggedOn = false;
        brokerAlgos = null;
        settings = null;
    }
    /**
     * Get the name value.
     *
     * @return a String value
     */
    public String getName()
    {
        return name;
    }
    /**
     * Get the brokerId value.
     *
     * @return a BrokerID value
     */
    public BrokerID getId()
    {
        return brokerId;
    }
    /**
     * Get the loggedOn value.
     *
     * @return a boolean value
     */
    public boolean getLoggedOn()
    {
        return loggedOn;
    }
    /**
     * Get the brokerAlgos value.
     *
     * @return a Set<BrokerAlgoSpec> value
     */
    public Set getBrokerAlgos()
    {
        return brokerAlgos;
    }
    /**
     * Get the settings value.
     *
     * @return a Map<String,String> value
     */
    public Map getSettings()
    {
        return settings;
    }
    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString()
    {
        return String.format("Broker: %s(%s,%s)", //$NON-NLS-1$
                             String.valueOf(getName()),
                             String.valueOf(getId()),
                             getLoggedOn());
    }
    /**
     * name value
     */
    private final String name;
    /**
     * broker id value
     */
    private final BrokerID brokerId;
    /**
     * logged on value
     */
    private final boolean loggedOn;
    /**
     * broker algos value
     */
    private final Set brokerAlgos;
    /**
     * broker settings value
     */
    private final Map settings;
    private static final long serialVersionUID = -4170685026349637823L;
}