org.hibernate.validator.internal.util.annotationfactory.AnnotationDescriptor Maven / Gradle / Ivy

/*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat, Inc. and/or its affiliates, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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 org.hibernate.validator.internal.util.annotationfactory;

import java.lang.annotation.Annotation;
import java.util.HashMap;
import java.util.Map;

/**
 * Encapsulates the data you need to create an annotation. In
 * particular, it stores the type of an Annotation instance
 * and the values of its elements.
 * The "elements" we're talking about are the annotation attributes,
 * not its targets (the term "element" is used ambiguously
 * in Java's annotations documentation).
 *
 * @author Paolo Perrotta
 * @author Davide Marchignoli
 * @author Hardy Ferentschik
 * @author Gunnar Morling
 */
public class AnnotationDescriptor {

	private final Class type;

	private final Map elements = new HashMap();

	/**
	 * Returns a new descriptor for the given annotation type.
	 *
	 * @param  The type of the annotation.
	 * @param annotationType The annotation's class.
	 *
	 * @return A new descriptor for the given annotation type.
	 */
	public static  AnnotationDescriptor getInstance(Class annotationType) {
		return new AnnotationDescriptor( annotationType );
	}

	/**
	 * Returns a new descriptor for the given annotation type.
	 *
	 * @param  The type of the annotation.
	 * @param annotationType The annotation's class.
	 * @param elements A map with attribute values for the annotation to be created.
	 *
	 * @return A new descriptor for the given annotation type.
	 */
	public static  AnnotationDescriptor getInstance(Class annotationType, Map elements) {
		return new AnnotationDescriptor( annotationType, elements );
	}

	public AnnotationDescriptor(Class annotationType) {
		this.type = annotationType;
	}

	public AnnotationDescriptor(Class annotationType, Map elements) {
		this.type = annotationType;
		for ( Map.Entry entry : elements.entrySet() ) {
			this.elements.put( entry.getKey(), entry.getValue() );
		}
	}

	public void setValue(String elementName, Object value) {
		elements.put( elementName, value );
	}

	public Object valueOf(String elementName) {
		return elements.get( elementName );
	}

	public boolean containsElement(String elementName) {
		return elements.containsKey( elementName );
	}

	public int numberOfElements() {
		return elements.size();
	}

	/**
	 * Returns a map with the elements contained in this descriptor keyed by name. This map is a copy
	 * of the internally used map, so it can safely be modified without altering this descriptor.
	 *
	 * @return A map with this descriptor's elements.
	 */
	public Map getElements() {
		return new HashMap( elements );
	}

	public Class type() {
		return type;
	}
}