ProtectedWrappedChannel.java

/*
 * JBoss, Home of Professional Open Source
 *
 * Copyright 2012 Red Hat, Inc. and/or its affiliates.
 *
 * 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.xnio.channels;

import java.nio.channels.Channel;

/**
 * A protected, wrapped channel.  A guard object is required to gain access to the underlying channel.
 *
 * @param <C> the wrapped channel type
 * @author <a href="mailto:david.lloyd@redhat.com">David M. Lloyd</a>
 */
public interface ProtectedWrappedChannel<C extends Channel> {

    /**
     * Get the channel which is wrapped by this object, or {@code null} if the guard is invalid.
     *
     * @param guard the guard object
     * @return the wrapped channel
     */
    C getChannel(Object guard);
}