Package org.apache.juneau.http.annotation

Class QueryAnnotation

java.lang.Object

org.apache.juneau.http.annotation.QueryAnnotation

public class QueryAnnotation
extends Object

Utility classes and methods for the @Query annotation.

See Also:

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Query	DEFAULT	Default value

Constructor Summary

Constructors

Constructor	Description
QueryAnnotation()

Method Summary

Modifier and Type	Method	Description
static QueryAnnotation.Builder	create()	Instantiates a new builder for this class.
static QueryAnnotation.Builder	create(Class<?>... on)	Instantiates a new builder for this class.
static QueryAnnotation.Builder	create(String... on)	Instantiates a new builder for this class.
static boolean	empty(Query 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 list 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 Query DEFAULT

Default value

Constructor Details

QueryAnnotation

public QueryAnnotation()

Method Details

create

public static QueryAnnotation.Builder create()

Instantiates a new builder for this class.

Returns:

A new builder object.

create

public static QueryAnnotation.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 QueryAnnotation.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(Query 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 list of annotations.

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.