StorableInfoCapability.java

/*
 * Copyright 2006-2012 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  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 com.amazon.carbonado.capability;

import com.amazon.carbonado.RepositoryException;
import com.amazon.carbonado.Storable;

/**
 * Capability that returns information about known storable types in a
 * repository.
 *
 * @author Brian S O'Neill
 */
public interface StorableInfoCapability extends Capability {
    /**
     * Returns an array of storable type class names for user-level storables
     * known to the repository. The array might be empty, but it is never
     * null. The array is a copy, and so it may be safely modified.
     * <p>
     * This method returns class names instead of class instances because the
     * repository may not be able to load the classes.
     */
    String[] getUserStorableTypeNames() throws RepositoryException;

    /**
     * Returns true if the given storable type is supported.
     *
     * @param type storable type to examine
     */
    boolean isSupported(Class<Storable> type);

    /**
     * Returns true if the given property exists and is supported.
     *
     * @param type storable type to examine
     * @param name name of property to examine
     */
    boolean isPropertySupported(Class<Storable> type, String name);
}