Package org.apache.juneau.http.annotation

Class HeaderAnnotation

java.lang.Object

org.apache.juneau.http.annotation.HeaderAnnotation

public class HeaderAnnotation
extends Object

Utility classes and methods for the @Header annotation.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HeaderAnnotation.Applier	Applies targeted Header annotations to a BeanContext.Builder.
static @interface	HeaderAnnotation.Array	A collection of @Header annotations.
static class	HeaderAnnotation.Builder	Builder class.

Field Summary

Fields

Modifier and Type	Field	Description
static final Header	DEFAULT	Default value

Constructor Summary

Constructors

Constructor	Description
HeaderAnnotation()

Method Summary

Modifier and Type	Method	Description
static HeaderAnnotation.Builder	create()	Instantiates a new builder for this class.
static HeaderAnnotation.Builder	create(Class<?>... on)	Instantiates a new builder for this class.
static HeaderAnnotation.Builder	create(String... on)	Instantiates a new builder for this class.
static boolean	empty(Header a)	Returns true if the specified annotation contains all default values.
static Value<String>	findDef(ParamInfo pi)	Finds the default value from the specified list of annotations.
static Value<String>	findName(ParamInfo pi)	Finds the name from the specified lists of annotations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT

public static final Header DEFAULT

Default value

Constructor Details

HeaderAnnotation

public HeaderAnnotation()

Method Details

create

public static HeaderAnnotation.Builder create()

Instantiates a new builder for this class.

Returns:

A new builder object.

create

public static HeaderAnnotation.Builder create(Class<?>... on)

Instantiates a new builder for this class.

Parameters:

on - The targets this annotation applies to.

Returns:

A new builder object.

create

public static HeaderAnnotation.Builder create(String... on)

Instantiates a new builder for this class.

Parameters:

on - The targets this annotation applies to.

Returns:

A new builder object.

empty

public static boolean empty(Header a)

Returns true if the specified annotation contains all default values.

Parameters:

a - The annotation to check.

Returns:

true if the specified annotation contains all default values.

findName

public static Value<String> findName(ParamInfo pi)

Finds the name from the specified lists of annotations.

The last matching name found is returned.

Parameters:

pi - The parameter.

Returns:

The last matching name, or Value.empty() if not found.

findDef

public static Value<String> findDef(ParamInfo pi)

Finds the default value from the specified list of annotations.

Parameters:

pi - The parameter.

Returns:

The last matching default value, or Value.empty() if not found.