org.apache.juneau.http.annotation.HeaderAnnotation Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * 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.http.annotation;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
import static org.apache.juneau.common.internal.StringUtils.*;
import static org.apache.juneau.internal.ArrayUtils.*;
import java.lang.annotation.*;
import java.lang.reflect.*;
import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
import org.apache.juneau.httppart.*;
import org.apache.juneau.reflect.*;
import org.apache.juneau.svl.*;
/**
* Utility classes and methods for the {@link Header @Header} annotation.
*
* See Also:
*
*/
public class HeaderAnnotation {
//-----------------------------------------------------------------------------------------------------------------
// Static
//-----------------------------------------------------------------------------------------------------------------
/** Default value */
public static final Header DEFAULT = create().build();
/**
* Instantiates a new builder for this class.
*
* @return A new builder object.
*/
public static Builder create() {
return new Builder();
}
/**
* Instantiates a new builder for this class.
*
* @param on The targets this annotation applies to.
* @return A new builder object.
*/
public static Builder create(Class...on) {
return create().on(on);
}
/**
* Instantiates a new builder for this class.
*
* @param on The targets this annotation applies to.
* @return A new builder object.
*/
public static Builder create(String...on) {
return create().on(on);
}
/**
* Returns true if the specified annotation contains all default values.
*
* @param a The annotation to check.
* @return true if the specified annotation contains all default values.
*/
public static boolean empty(Header a) {
return a == null || DEFAULT.equals(a);
}
/**
* Finds the name from the specified lists of annotations.
*
*
* The last matching name found is returned.
*
* @param pi The parameter.
* @return The last matching name, or {@link Value#empty()} if not found.
*/
public static Value findName(ParamInfo pi) {
Value n = Value.empty();
pi.forEachAnnotation(Header.class, x -> isNotEmpty(x.value()), x -> n.set(x.value()));
pi.forEachAnnotation(Header.class, x -> isNotEmpty(x.name()), x -> n.set(x.name()));
return n;
}
/**
* Finds the default value from the specified list of annotations.
*
* @param pi The parameter.
* @return The last matching default value, or {@link Value#empty()} if not found.
*/
public static Value findDef(ParamInfo pi) {
Value n = Value.empty();
pi.forEachAnnotation(Header.class, x -> isNotEmpty(x.def()), x -> n.set(x.def()));
return n;
}
//-----------------------------------------------------------------------------------------------------------------
// Builder
//-----------------------------------------------------------------------------------------------------------------
/**
* Builder class.
*
* See Also:
* - {@link org.apache.juneau.BeanContext.Builder#annotations(Annotation...)}
*
*/
public static class Builder extends TargetedAnnotationTMFBuilder {
Class parser = HttpPartParser.Void.class;
Class serializer = HttpPartSerializer.Void.class;
Schema schema = SchemaAnnotation.DEFAULT;
String name="", value="", def="";
/**
* Constructor.
*/
protected Builder() {
super(Header.class);
}
/**
* Instantiates a new {@link Header @Header} object initialized with this builder.
*
* @return A new {@link Header @Header} object.
*/
public Header build() {
return new Impl(this);
}
/**
* Sets the {@link Header#def} property on this annotation.
*
* @param value The new value for this property.
* @return This object.
*/
public Builder def(String value) {
this.def = value;
return this;
}
/**
* Sets the {@link Header#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 Header#parser} property on this annotation.
*
* @param value The new value for this property.
* @return This object.
*/
public Builder parser(Class value) {
this.parser = value;
return this;
}
/**
* Sets the {@link Header#schema} property on this annotation.
*
* @param value The new value for this property.
* @return This object.
*/
public Builder schema(Schema value) {
this.schema = value;
return this;
}
/**
* Sets the {@link Header#serializer} property on this annotation.
*
* @param value The new value for this property.
* @return This object.
*/
public Builder serializer(Class value) {
this.serializer = value;
return this;
}
/**
* Sets the {@link Header#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;
}
//
@Override /* GENERATED - TargetedAnnotationBuilder */
public Builder on(String...values) {
super.on(values);
return this;
}
@Override /* GENERATED - TargetedAnnotationTBuilder */
public Builder on(java.lang.Class...value) {
super.on(value);
return this;
}
@Override /* GENERATED - TargetedAnnotationTBuilder */
public Builder onClass(java.lang.Class...value) {
super.onClass(value);
return this;
}
@Override /* GENERATED - TargetedAnnotationTMFBuilder */
public Builder on(Field...value) {
super.on(value);
return this;
}
@Override /* GENERATED - TargetedAnnotationTMFBuilder */
public Builder on(Method...value) {
super.on(value);
return this;
}
//
}
//-----------------------------------------------------------------------------------------------------------------
// Implementation
//-----------------------------------------------------------------------------------------------------------------
private static class Impl extends TargetedAnnotationTImpl implements Header {
private final Class parser;
private final Class serializer;
private final String name, value, def;
private final Schema schema;
Impl(Builder b) {
super(b);
this.def = b.def;
this.name = b.name;
this.parser = b.parser;
this.schema = b.schema;
this.serializer = b.serializer;
this.value = b.value;
postConstruct();
}
@Override /* Header */
public String def() {
return def;
}
@Override /* Header */
public String name() {
return name;
}
@Override /* Header */
public Class parser() {
return parser;
}
@Override /* Header */
public Schema schema() {
return schema;
}
@Override /* Header */
public Class serializer() {
return serializer;
}
@Override /* Header */
public String value() {
return value;
}
}
//-----------------------------------------------------------------------------------------------------------------
// Appliers
//-----------------------------------------------------------------------------------------------------------------
/**
* Applies targeted {@link Header} annotations to a {@link org.apache.juneau.BeanContext.Builder}.
*/
public static class Applier extends AnnotationApplier {
/**
* Constructor.
*
* @param vr The resolver for resolving values in annotations.
*/
public Applier(VarResolverSession vr) {
super(Header.class, BeanContext.Builder.class, vr);
}
@Override
public void apply(AnnotationInfo ai, BeanContext.Builder b) {
Header a = ai.inner();
if (isEmptyArray(a.on(), a.onClass()))
return;
b.annotations(a);
}
}
//-----------------------------------------------------------------------------------------------------------------
// Other
//-----------------------------------------------------------------------------------------------------------------
/**
* A collection of {@link Header @Header annotations}.
*/
@Documented
@Target({METHOD,TYPE})
@Retention(RUNTIME)
@Inherited
public static @interface Array {
/**
* The child annotations.
*
* @return The annotation value.
*/
Header[] value();
}
}