org.red5.io.object.BaseOutput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of red5-io Show documentation
The Red5 I/O library
There is a newer version: 2.0.15
/*
 * RED5 Open Source Media Server - https://github.com/Red5/ Copyright 2006-2023 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.io.object;

import java.util.HashMap;
import java.util.Map;

/**
 * BaseOutput represents a way to map input to a HashMap. This class is meant to be extended.
 *
 * @author The Red5 Project
 * @author Luke Hubbard, Codegent Ltd ([email protected])
 */
public class BaseOutput {

    static class IdentityWrapper {
        /**
         * Wrapped object
         */
        final Object object;

        /**
         * Creates wrapper for object
         *
         * @param object
         *            Object to wrap
         */
        public IdentityWrapper(Object object) {
            this.object = object;
        }

        /** {@inheritDoc} */
        @Override
        public int hashCode() {
            return System.identityHashCode(object);
        }

        /** {@inheritDoc} */
        @Override
        public boolean equals(Object object) {
            if (object instanceof IdentityWrapper) {
                return ((IdentityWrapper) object).object == this.object;
            }
            return false;
        }

    }

    /**
     * References map
     */
    protected Map refMap;

    /**
     * Reference id
     */
    protected short refId;

    /**
     * BaseOutput Constructor
     *
     */
    protected BaseOutput() {
        refMap = new HashMap<>();
    }

    /**
     * Store an object into a map
     *
     * @param obj
     *            Object to store
     */
    protected void storeReference(Object obj) {
        refMap.put(new IdentityWrapper(obj), Short.valueOf(refId++));
    }

    /**
     * Returns a boolean stating whether the map contains an object with that key
     *
     * @param obj
     *            Object
     * @return boolean true if it does contain it, false otherwise
     */
    protected boolean hasReference(Object obj) {
        return refMap.containsKey(new IdentityWrapper(obj));
    }

    /**
     * Clears the map
     */
    public void clearReferences() {
        refMap.clear();
        refId = 0;
    }

    /**
     * Returns the reference id based on the parameter obj
     *
     * @param obj
     *            Object
     * @return short Reference id
     */
    protected short getReferenceId(Object obj) {
        return refMap.get(new IdentityWrapper(obj)).shortValue();
    }

}