org.apache.juneau.rest.annotation.RestInjectAnnotation Maven / Gradle / Ivy

Go to download
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you 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.apache.juneau.rest.annotation;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

import java.lang.annotation.*;

import org.apache.juneau.annotation.*;

/**
 * Utility classes and methods for the {@link RestInject RestInject} annotation.
 *
 * See Also:

 * 
 */
public class RestInjectAnnotation {

	//-----------------------------------------------------------------------------------------------------------------
	// Static
	//-----------------------------------------------------------------------------------------------------------------

	/** Default value */
	public static final RestInject DEFAULT = create().build();

	/**
	 * Instantiates a new builder for this class.
	 *
	 * @return A new builder object.
	 */
	public static Builder create() {
		return new Builder();
	}

	/**
	 * Pulls the name/value attribute from a {@link RestInject} annotation.
	 *
	 * @param a The annotation to check.  Can be null.
	 * @return The annotation value, or an empty string if the annotation is null.
	 */
	public static String name(RestInject a) {
		if (a == null)
			return "";
		if (! a.name().isEmpty())
			return a.name();
		return a.value();
	}

	//-----------------------------------------------------------------------------------------------------------------
	// Builder
	//-----------------------------------------------------------------------------------------------------------------

	/**
	 * Builder class.
	 *
	 * See Also:

	 * 	{@link org.apache.juneau.BeanContext.Builder#annotations(Annotation...)}
	 * 
	 */
	public static class Builder extends TargetedAnnotationMBuilder {

		String name, value;
		String[] methodScope;

		/**
		 * Constructor.
		 */
		protected Builder() {
			super(RestInject.class);
		}

		/**
		 * Instantiates a new {@link RestInject @RestInject} object initialized with this builder.
		 *
		 * @return A new {@link RestInject @RestInject} object.
		 */
		public RestInject build() {
			return new Impl(this);
		}

		/**
		 * Sets the {@link RestInject#name()} property on this annotation.
		 *
		 * @param value The new value for this property.
		 * @return This object.
		 */
		public Builder name(String value) {
			this.name = value;
			return this;
		}

		/**
		 * Sets the {@link RestInject#value()} property on this annotation.
		 *
		 * @param value The new value for this property.
		 * @return This object.
		 */
		public Builder value(String value) {
			this.value = value;
			return this;
		}

		/**
		 * Sets the {@link RestInject#methodScope()} property on this annotation.
		 *
		 * @param value The new value for this property.
		 * @return This object.
		 */
		public Builder methodScope(String...value) {
			this.methodScope = value;
			return this;
		}

		// 

		@Override /* GENERATED - TargetedAnnotationBuilder */
		public Builder on(String...values) {
			super.on(values);
			return this;
		}

		@Override /* GENERATED - TargetedAnnotationTMBuilder */
		public Builder on(java.lang.reflect.Method...value) {
			super.on(value);
			return this;
		}

		// 
	}

	//-----------------------------------------------------------------------------------------------------------------
	// Implementation
	//-----------------------------------------------------------------------------------------------------------------

	private static class Impl extends TargetedAnnotationImpl implements RestInject {

		private final String name, value;
		private final String[] methodScope;

		Impl(Builder b) {
			super(b);
			this.name = b.name;
			this.value = b.value;
			this.methodScope = b.methodScope;
			postConstruct();
		}

		@Override /* RestInject */
		public String name() {
			return name;
		}

		@Override /* RestInject */
		public String value() {
			return value;
		}

		@Override /* RestInject */
		public String[] methodScope() {
			return methodScope;
		}
	}

	//-----------------------------------------------------------------------------------------------------------------
	// Other
	//-----------------------------------------------------------------------------------------------------------------

	/**
	 * A collection of {@link RestInject @RestInject annotations}.
	 */
	@Documented
	@Target({FIELD,METHOD,TYPE})
	@Retention(RUNTIME)
	@Inherited
	public static @interface Array {

		/**
		 * The child annotations.
		 *
		 * @return The annotation value.
		 */
		RestInject[] value();
	}
}