com.sun.xml.bind.v2.model.annotation.AnnotationSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaxb-impl Show documentation

Old JAXB Runtime module. Contains sources required for runtime processing.

There is a newer version: 4.0.5

/*
 * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package com.sun.xml.bind.v2.model.annotation;

import java.lang.annotation.Annotation;

/**
 * Implemented by objects that can have annotations.
 *
 * @author Kohsuke Kawaguchi
 */
public interface AnnotationSource {
    /**
     * Gets the value of the specified annotation from the given property.
     *
     * 
     * When this method is used for a property that consists of a getter and setter,
     * it returns the annotation on either of those methods. If both methods have
     * the same annotation, it is an error.
     *
     * @return
     *      null if the annotation is not present.
     */
     A readAnnotation(Class annotationType);

    /**
     * Returns true if the property has the specified annotation.
     * 
     * Short for readAnnotation(annotationType)!=null,
     * but this method is typically faster.
     */
    boolean hasAnnotation(Class annotationType);
}