Package org.apache.juneau.http.annotation

Class PathAnnotation.Builder

java.lang.Object

org.apache.juneau.commons.annotation.AnnotationObject.Builder

org.apache.juneau.commons.annotation.AppliedAnnotationObject.Builder

org.apache.juneau.commons.annotation.AppliedAnnotationObject.BuilderT

org.apache.juneau.commons.annotation.AppliedAnnotationObject.BuilderTMF

org.apache.juneau.http.annotation.PathAnnotation.Builder

Enclosing class:

PathAnnotation

public static class PathAnnotation.Builder
extends AppliedAnnotationObject.BuilderTMF

Builder class.

See Also:

• BeanContext.Builder.annotations(Annotation...)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
Path	build()	Instantiates a new @Path object initialized with this builder.
PathAnnotation.Builder	def(String value)	Sets the Path.name() property on this annotation.
PathAnnotation.Builder	description(String... value)	Sets the description property on this annotation.
PathAnnotation.Builder	name(String value)	Sets the Path.name() property on this annotation.
PathAnnotation.Builder	on(Class<?>... value)	Appends the classes that this annotation applies to.
PathAnnotation.Builder	on(Field... value)	Appends the fields that this annotation applies to.
PathAnnotation.Builder	on(Method... value)	Appends the methods that this annotation applies to.
PathAnnotation.Builder	on(String... value)	The targets this annotation applies to.
PathAnnotation.Builder	on(ClassInfo... value)	Appends the classes that this annotation applies to.
PathAnnotation.Builder	on(FieldInfo... value)	Appends the fields that this annotation applies to.
PathAnnotation.Builder	on(MethodInfo... value)	Appends the methods that this annotation applies to.
PathAnnotation.Builder	onClass(Class<?>... value)	Appends the classes that this annotation applies to.
PathAnnotation.Builder	onClass(ClassInfo... value)	Appends the classes that this annotation applies to.
PathAnnotation.Builder	parser(Class<? extends HttpPartParser> value)	Sets the Path.parser() property on this annotation.
PathAnnotation.Builder	schema(Schema value)	Sets the Path.schema() property on this annotation.
PathAnnotation.Builder	serializer(Class<? extends HttpPartSerializer> value)	Sets the Path.serializer() property on this annotation.
PathAnnotation.Builder	value(String value)	Sets the Path.value() property on this annotation.

Methods inherited from class org.apache.juneau.commons.annotation.AnnotationObject.Builder

getAnnotationType

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor.

Method Details

build

public Path build()

Instantiates a new @Path object initialized with this builder.

Returns:

A new @Path object.

description

public PathAnnotation.Builder description(String... value)

Sets the description property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

def

public PathAnnotation.Builder def(String value)

Sets the Path.name() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

name

public PathAnnotation.Builder name(String value)

Sets the Path.name() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

parser

public PathAnnotation.Builder parser(Class<? extends HttpPartParser> value)

Sets the Path.parser() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

schema

public PathAnnotation.Builder schema(Schema value)

Sets the Path.schema() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

serializer

public PathAnnotation.Builder serializer(Class<? extends HttpPartSerializer> value)

Sets the Path.serializer() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

value

public PathAnnotation.Builder value(String value)

Sets the Path.value() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

on

public PathAnnotation.Builder on(String... value)

Description copied from class: AppliedAnnotationObject.Builder

The targets this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.Builder

Parameters:

value - The targets this annotation applies to.

Returns:

This object.

on

public PathAnnotation.Builder on(Class<?>... value)

Description copied from class: AppliedAnnotationObject.BuilderT

Appends the classes that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderT

Parameters:

value - The values to append.

Returns:

This object.

onClass

public PathAnnotation.Builder onClass(Class<?>... value)

Description copied from class: AppliedAnnotationObject.BuilderT

Appends the classes that this annotation applies to.

Overrides:

onClass in class AppliedAnnotationObject.BuilderT

Parameters:

value - The values to append.

Returns:

This object.

on

public PathAnnotation.Builder on(Method... value)

Description copied from class: AppliedAnnotationObject.BuilderTMF

Appends the methods that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTMF

Parameters:

value - The values to append.

Returns:

This object.

on

public PathAnnotation.Builder on(Field... value)

Description copied from class: AppliedAnnotationObject.BuilderTMF

Appends the fields that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTMF

Parameters:

value - The values to append.

Returns:

This object.

on

public PathAnnotation.Builder on(ClassInfo... value)

Description copied from class: AppliedAnnotationObject.BuilderT

Appends the classes that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderT

Parameters:

value - The values to append.

Returns:

This object.

onClass

public PathAnnotation.Builder onClass(ClassInfo... value)

Description copied from class: AppliedAnnotationObject.BuilderT

Appends the classes that this annotation applies to.

Overrides:

onClass in class AppliedAnnotationObject.BuilderT

Parameters:

value - The values to append.

Returns:

This object.

on

public PathAnnotation.Builder on(FieldInfo... value)

Description copied from class: AppliedAnnotationObject.BuilderTMF

Appends the fields that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTMF

Parameters:

value - The values to append.

Returns:

This object.

on

public PathAnnotation.Builder on(MethodInfo... value)

Description copied from class: AppliedAnnotationObject.BuilderTMF

Appends the methods that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTMF

Parameters:

value - The values to append.

Returns:

This object.