de.schlichtherle.crypto.io.raes.RaesParametersAgent Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2006-2010 Schlichtherle IT Services
 *
 * 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 de.schlichtherle.crypto.io.raes;

/**
 * These {@link RaesParameters} delegate to some other instance of a sibling
 * interface or itself in order to locate the parameters required to read
 * or write a certain RAES type.
 * This may be implemented by clients to build RAES parameters of a certain
 * type on demand rather than providing them upfront.
 * 
 * There are two usages of this interface:
 * 

 * {@link RaesReadOnlyFile#getInstance} uses it to locate RAES parameters
 *     which match the RAES type found in the file unless the provided
 *     parameters already match the required type.
 * 
{@link RaesOutputStream#getInstance} uses it to allow the client
 *     explict control about the type of RAES file created.
 * 
 *
 * @author Christian Schlichtherle
 * @version $Id: RaesParametersAgent.java,v 1.4 2010/08/20 13:09:38 christian_schlichtherle Exp $
 * @since TrueZIP 6.0
 */
public interface RaesParametersAgent extends RaesParameters {
    
    /**
     * Requests an {@link RaesParameters} instance of the given
     * {@code type}.
     * It is permissible to return an instance of any other implementation
     * of the {@code RaesParameters} interface.
     * If the returned object is an instance of an implementation of this
     * interface, it will be used to continue the search for RAES parameters
     * recursively.
     * Otherwise the search will be aborted.
     *
     * @param type The {@link RaesParameters} interface class which's
     *        implementation is searched.
     *
     * @return An instance of {@code RaesParameters} or {@code null}
     *         if no RAES parameters are available.
     */
    RaesParameters getParameters(Class type);
}