core/src/main/java/org/apache/myfaces/extensions/validator/core/storage/StorageManagerHolder.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.myfaces.extensions.validator.core.storage;

import org.apache.myfaces.extensions.validator.internal.UsageInformation;
import static org.apache.myfaces.extensions.validator.internal.UsageCategory.API;

/**
 * Interface to manage storage-manager instances.
 *
 * @see org.apache.myfaces.extensions.validator.core.storage.StorageManager
 *
 * @since x.x.3
 */
@UsageInformation(API)
public interface StorageManagerHolder
{
    /**
     * Define the storage manager for the given type.
     *
     * @param type The identification for the storage manager, usually it is the storage-class
     * @param storageManager The storageManager to use.
     * @param override use true to replace an existing storageManager and
     * false to use the manager only if there isn't an existing manager for the given type
     */
    void setStorageManager(Class type, StorageManager storageManager, boolean override);

    /**
     * Returns the storageManager for the given type.
     *
     * @param type The identification for the storage manager, usually it is the storage-class
     * @return the storageManager for the given type or null
     */
    StorageManager getStorageManager(Class type);
}