com.openpojo.reflection.PojoElement Maven / Gradle / Ivy

Go to download

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

This project was born out of a need to validate all POJOs (Plain Old Java Object) are behaving correctly. This project has two main aspects to it: * Make Testing as easy as possible. * Simplifying identity management (hashCode / equals) using annotation.

There is a newer version: 0.7.3

Show newest version

/*
 * Copyright (c) 2010-2013 Osman Shoukry
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU Lesser General Public License as published by
 *    the Free Software Foundation, either version 3 of the License or any
 *    later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public License
 *    along with this program.  If not, see .
 */

package com.openpojo.reflection;

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

/**
 * This is the parent interface for all wrapped types.
 * 
 * @author oshoukry
 */
public interface PojoElement {

    /**
     * Get the name of the element.
     * 
     * @return
     *         Return the name of the package, class, field... etc.
     */
    public String getName();

    /**
     * Get all annotations defined on element.
     * 
     * @return
     *         Get Annotations
     */
    public List getAnnotations();

    /**
     * Get specified instance of an annotation defined on element.
     * 
     * @param 
     *            Class Type of annotation.
     * @param annotationClass
     *            The annotation class.
     * @return
     *         The definition of this annotation on the PojoField.
     */
    public  T getAnnotation(final Class annotationClass);

}