jakarta.faces.view.facelets.MetadataTarget Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation
EE4J Compatible Implementation for Jakarta Faces API
There is a newer version: 4.1.1
/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 * Copyright 2005-2007 The Apache Software Foundation
 *
 * 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 jakarta.faces.view.facelets;

import java.beans.PropertyDescriptor;
import java.lang.reflect.Method;

/**
 * 
 * Information used with {@link MetaRule} for determining how and what {@link Metadata} should be wired.
 * 
 *
 * @since 2.0
 */
public abstract class MetadataTarget {

    /**
     * 
     * Return a beans PropertyDescriptor for the property with name given by argument name.
     * 
     *
     * @param name the name of the property for which the PropertyDescriptor must be returned.
     * @return the {@link PropertyDescriptor}.
     */
    public abstract PropertyDescriptor getProperty(String name);

    /**
     * 
     * Return true if the target for this metadata element is an instance of the argument type.
     * 
     *
     * @param type the Class to test for the instance of.
     * @return true if the type is a target instance, false otherwise.
     */
    public abstract boolean isTargetInstanceOf(Class type);

    /**
     * 
     * Return the Class of the metadata target.
     * 
     *
     * @return the target Class.
     */
    public abstract Class getTargetClass();

    /**
     * 
     * Return a Class for the property with name given by argument name.
     * 
     *
     * @param name the name of the property for which the Class must be returned.
     * @return the Class of the property.
     */
    public abstract Class getPropertyType(String name);

    /**
     * 
     * Return a Method for the setter of the property with name given by argument name.
     * 
     *
     * @param name the name of the property for which the Method must be returned.
     * @return the write {@link Method}.
     */
    public abstract Method getWriteMethod(String name);

    /**
     * 
     * Return a Method for the getter of the property with name given by argument name.
     * 
     *
     * @param name the name of the property for which the Method must be returned.
     * @return the read {@link Method}.
     */
    public abstract Method getReadMethod(String name);
}