org.apache.deltaspike.core.api.config.view.metadata.ConfigDescriptor Maven / Gradle / Ivy

/*
 * 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.deltaspike.core.api.config.view.metadata;

import java.lang.annotation.Annotation;
import java.util.List;

/**
 * Base descriptor for all type-safe view-configs which represents the
 * config-class and meta-data, callbacks,... provided by/bound to this class.
 */
public interface ConfigDescriptor
{
    Class getConfigClass();

    /**
     * Meta-data which is configured for the entry. It allows to provide and resolve meta-data annotated
     * with {@link ViewMetaData}
     *
     * @return meta-data of the current entry
     */
    List getMetaData();

    /**
     * Meta-data which is configured for the entry. It allows to provide and resolve meta-data annotated
     * with {@link ViewMetaData}
     *
     * @param target target type
     * @return custom meta-data for the given type of the current entry
     */
     List getMetaData(Class target);

    /**
     * Callbacks which are configured for the entry and bound to the given meta-data type.
     * @param metaDataType type of the meta-data (e.g. PageBean.class)
     * @return descriptor for the callback or null if there is no callback-method
     */
    CallbackDescriptor getCallbackDescriptor(Class metaDataType);

    /**
     * Callbacks which are configured for the entry and bound to the given meta-data type.
     * @param metaDataType type of the meta-data (e.g. PageBean.class)
     * @param callbackType type of the callback (e.g. PreRenderView.class)
     * @return descriptor for the callback null if there is no callback-method
     */
    CallbackDescriptor getCallbackDescriptor(Class metaDataType,
                                             Class callbackType);

    /**
     * Callbacks which are configured for the entry and bound to the given meta-data type.
     * @param metaDataType type of the meta-data (e.g. PageBean.class)
     * @param executorType type of the executor which allows to get a typed result (e.g. Secured.Descriptor)
     * @return descriptor for the callback which also allows to invoke it or null if there is no callback-method
     */
     T getExecutableCallbackDescriptor(Class metaDataType,
                                                                               Class executorType);

    /**
     * Callbacks which are configured for the entry and bound to the given meta-data type.
     * @param metaDataType type of the meta-data (e.g. PageBean.class)
     * @param callbackType type of the callback (e.g. PreRenderView.class)
     * @param executorType type of the executor which allows to get a typed result (e.g. Secured.Descriptor)
     * @return descriptor for the callback which also allows to invoke it or null if there is no callback-method
     */
     T getExecutableCallbackDescriptor(Class metaDataType,
                                                                               Class callbackType,
                                                                               Class executorType);

    /**
     * Returns the string representation of the resource represented by #getConfigClass
     * @return relative path to the folder or page
     */
    String getPath();
}