com.buschmais.jqassistant.plugin.javaee6.api.model.JsfFaceletDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javaee6 Show documentation

Plugin for jQAssistant to be able to scan and to analyze Java EE 6 related artifacts.

There is a newer version: 1.12.2

package com.buschmais.jqassistant.plugin.javaee6.api.model;

import java.util.Set;

import com.buschmais.jqassistant.plugin.common.api.model.FileDescriptor;
import com.buschmais.xo.neo4j.api.annotation.Label;
import com.buschmais.xo.neo4j.api.annotation.Relation;

/**
 * Representing a JSF template file in the jqassistant store.
 *
 * @author [email protected]
 */
@Label(value = "Facelet")
public interface JsfFaceletDescriptor extends JsfDescriptor, FileDescriptor {

    /**
     * Included JSF Templates.
     *
     * @return a Set of {@link JsfFaceletDescriptor} that are included in the
     *         current template.
     */
    @Relation("INCLUDES")
    Set getIncludes();

    /**
     * Sets a set of included files.
     *
     * @param includes
     *            the descriptors of the files.
     */
    void setIncludes(Set includes);

    /**
     * If the current {@link JsfFaceletDescriptor} links to a template it can
     * requested with this method.
     *
     * @return the {@link JsfFaceletDescriptor} of the Template or
     *         null
     */
    @Relation("WITH_TEMPLATE")
    JsfFaceletDescriptor getTemplate();

    /**
     * Sets a Template Descriptor.
     *
     * @param template
     *            the {@link JsfFaceletDescriptor}
     */
    void setTemplate(JsfFaceletDescriptor template);

}