org.red5.server.api.IAttributeStore Maven / Gradle / Ivy

Go to download
/*
 * RED5 Open Source Media Server - https://github.com/Red5/
 * 
 * Copyright 2006-2016 by respective authors (see below). All rights reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.red5.server.api;

import java.util.Map;
import java.util.Set;

import org.red5.server.jmx.mxbeans.AttributeStoreMXBean;

/**
 * Base interface for all API objects with attributes
 * 
 * @author The Red5 Project
 * @author Luke Hubbard ([email protected])
 */
public interface IAttributeStore extends AttributeStoreMXBean {

    /**
     * Get the attribute names. The resulting set will be read-only.
     * 
     * @return set containing all attribute names
     */
    public Set getAttributeNames();

    /**
     * Get the attributes. The resulting map will be read-only.
     * 
     * @return map containing all attributes
     */
    public Map getAttributes();

    /**
     * Set an attribute on this object.
     * 
     * @param name
     *            the name of the attribute to change
     * @param value
     *            the new value of the attribute
     * @return true if the attribute value changed otherwise false
     */
    public boolean setAttribute(String name, Object value);

    /**
     * Set multiple attributes on this object.
     * 
     * @param values
     *            the attributes to set
     * @return true if the attribute values changed otherwise false
     */
    public boolean setAttributes(Map values);

    /**
     * Set multiple attributes on this object.
     * 
     * @param values
     *            the attributes to set
     * @return true if the attribute values changed otherwise false
     */
    public boolean setAttributes(IAttributeStore values);

    /**
     * Return the value for a given attribute.
     * 
     * @param name
     *            the name of the attribute to get
     * @return the attribute value or null if the attribute doesn't exist
     */
    public Object getAttribute(String name);

    /**
     * Return the value for a given attribute and set it if it doesn't exist.
     * 
     * This is a utility function that internally performs the following code: 

     * 
     *      * if (!hasAttribute(name))
     *     setAttribute(name, defaultValue);
     * return getAttribute(name);
     * 
     * 
     * @param name
     *            the name of the attribute to get
     * @param defaultValue
     *            the value of the attribute to set if the attribute doesn't exist
     * @return the attribute value
     */
    public Object getAttribute(String name, Object defaultValue);

    /**
     * Check the object has an attribute.
     * 
     * @param name
     *            the name of the attribute to check
     * @return true if the attribute exists otherwise false
     */
    public boolean hasAttribute(String name);

    /**
     * Remove an attribute.
     * 
     * @param name
     *            the name of the attribute to remove
     * @return true if the attribute was found and removed otherwise false
     */
    public boolean removeAttribute(String name);

    /**
     * Remove all attributes.
     */
    public void removeAttributes();

    /**
     * Size of the attribute store.
     * 
     * @return count of attributes
     */
    public int size();

}