org.jitsi.impl.neomedia.control.ReadOnlyBufferControlDelegate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libjitsi Show documentation
libjitsi is an advanced Java media library for secure real-time audio/video communication
The newest version!
/*
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * 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.jitsi.impl.neomedia.control;

import javax.media.control.*;

/**
 * Represents a wrapper of a specific BufferControl which does not call
 * the setters of the wrapped instance and calls only the getters.
 *
 * @author Lubomir Marinov
 */
public class ReadOnlyBufferControlDelegate
    implements BufferControl
{

    /**
     * The BufferControl wrapped by this instance.
     */
    private final BufferControl bufferControl;

    /**
     * Initializes a new ReadOnlyBufferControlDelegate instance which
     * is to wrap a specific BufferControl and call only its getters.
     *
     * @param bufferControl the BufferControl to be wrapped by the new
     * instance
     */
    public ReadOnlyBufferControlDelegate(BufferControl bufferControl)
    {
        this.bufferControl = bufferControl;
    }

    /**
     * Implements {@link BufferControl#getBufferLength()}. Gets the length in
     * milliseconds of the buffering performed by the owner of the wrapped
     * BufferControl.
     *
     * @return the length in milliseconds of the buffering performed by the
     * owner of the wrapped BufferControl
     */
    public long getBufferLength()
    {
        return bufferControl.getBufferLength();
    }

    /**
     * Implements {@link javax.media.Control#getControlComponent()}. Gets the UI
     * Component representing this instance and exported by the owner
     * of the wrapped BufferControl.
     *
     * @return the UI Component representing the wrapped
     * BufferControl and exported by its owner if such a
     * Component is available; otherwise, null
     */
    public java.awt.Component getControlComponent()
    {
        return bufferControl.getControlComponent();
    }

    /**
     * Implements {@link BufferControl#getEnabledThreshold()}. Gets the
     * indicator of the wrapped BufferControl which determines whether
     * threshold calculations are enabled.
     *
     * @return true if threshold calculations are enabled in the
     * wrapped BufferControl; otherwise, false
     */
    public boolean getEnabledThreshold()
    {
        return bufferControl.getEnabledThreshold();
    }

    /**
     * Implements {@link BufferControl#getMinimumThreshold()}. Gets the minimum
     * threshold in milliseconds for the buffering performed by the owner of the
     * wrapped BufferControl.
     *
     * @return the minimum threshold in milliseconds for the buffering performed
     * by the owner of the wrapped BufferControl
     */
    public long getMinimumThreshold()
    {
        return bufferControl.getMinimumThreshold();
    }

    /**
     * Implements {@link BufferControl#setBufferLength(long)}. Ignores the
     * request because this instance provides read-only support and returns the
     * value actually in effect.
     *
     * @param bufferLength the length in milliseconds of the buffering to be
     * performed by the owner of the wrapped BufferControl
     * @return the length in milliseconds of the buffering performed by the
     * owner of the wrapped BufferControl that is actually in effect
     */
    public long setBufferLength(long bufferLength)
    {
        return getBufferLength();
    }

    /**
     * Implements {@link BufferControl#setEnabledThreshold(boolean)}. Ignores
     * the set request because this instance provides read-only support.
     *
     * @param enabledThreshold true if threshold calculations are
     * to be enabled; otherwise, false
     */
    public void setEnabledThreshold(boolean enabledThreshold)
    {
    }

    /**
     * Implements {@link BufferControl#setMinimumThreshold(long)}. Ignores the
     * set request because this instance provides read-only support and returns
     * the value actually in effect.
     *
     * @param minimumThreshold the minimum threshold in milliseconds for the
     * buffering to be performed by the owner of the wrapped
     * BufferControl
     * @return the minimum threshold in milliseconds for the buffering performed
     * by the owner of the wrapped BufferControl that is actually in
     * effect
     */
    public long setMinimumThreshold(long minimumThreshold)
    {
        return getMinimumThreshold();
    }
}