com.legstar.host.invoke.model.HostContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of legstar-distribution
Used to create a single distribution for the entire LegStar project.
The newest version!
/*******************************************************************************
 * Copyright (c) 2010 LegSem.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser Public License v2.1
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * 
 * Contributors:
 *     LegSem - initial API and implementation
 ******************************************************************************/
package com.legstar.host.invoke.model;

import org.json.JSONException;
import org.json.JSONObject;
import org.json.JSONStringer;

/**
 * Provides the properties of a host container. Containers are named and are similar to blobs
 * (their content is untyped).
 */
public class HostContainer {

    /** JSON identifier for container name.*/
    public static final String CONTAINER_NAME_LABEL = "containerName";

    /** JSON identifier for container size.*/
    public static final String CONTAINER_SIZE_LABEL = "containerLength";

    /** The container name. */
    private String _name;

    /** The container data size. */
    private int _length;

    /**
     * Bean constructor.
     */
    public HostContainer() {
        
    }

    /**
     * Shorthand constructor.
     * @param name container name
     * @param length container maximum size
     */
    public HostContainer(final String name, final int length) {
        _name = name;
        _length = length;
    }

    /**
     * @return the container name.
     */
    public String getName() {
        return _name;
    }

    /**
     * @param name the container name to set.
     */
    public void setName(final String name) {
        _name = name;
    }

    /**
     * @return the container data size.
     */
    public int getLength() {
        return _length;
    }

    /**
     * @param length the container data size to set.
     */
    public void setLength(final int length) {
        _length = length;
    }

    /**
     * Creates a valid JSON representation of this object.
     * @return  a string serialization of the JSON object
     * @see java.lang.Object#toString()
     */
    public String toString() {
        try {
            JSONStringer stringer = new JSONStringer();
            stringer.object()
                .key(CONTAINER_NAME_LABEL)
                .value(getName())
                .key(CONTAINER_SIZE_LABEL)
                .value(getLength())
            .endObject();
            return stringer.toString();
        } catch (JSONException e) {
            return "Unable to string object. Got " + e;
        }
    }
    
    /**
     * @return this instance as a JSON object
     * @throws JSONException if JSONification fails
     */
    public JSONObject toJSON() throws JSONException {
        JSONObject o = new JSONObject();
        o.put(CONTAINER_NAME_LABEL, getName());
        o.put(CONTAINER_SIZE_LABEL, getLength());
        return o;
    }

}