Package org.apache.juneau.xml.annotation

Class XmlAnnotation.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.xml.annotation.XmlAnnotation.Builder

Enclosing class:

XmlAnnotation

public static class XmlAnnotation.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
Xml	build()	Instantiates a new @Xml object initialized with this builder.
XmlAnnotation.Builder	childName(String value)	Sets the Xml.childName() property on this annotation.
XmlAnnotation.Builder	description(String... value)	Sets the description property on this annotation.
XmlAnnotation.Builder	format(XmlFormat value)	Sets the Xml.format() property on this annotation.
XmlAnnotation.Builder	namespace(String value)	Sets the Xml.namespace() property on this annotation.
XmlAnnotation.Builder	on(Class<?>... value)	Appends the classes that this annotation applies to.
XmlAnnotation.Builder	on(Field... value)	Appends the fields that this annotation applies to.
XmlAnnotation.Builder	on(Method... value)	Appends the methods that this annotation applies to.
XmlAnnotation.Builder	on(String... value)	The targets this annotation applies to.
XmlAnnotation.Builder	on(ClassInfo... value)	Appends the classes that this annotation applies to.
XmlAnnotation.Builder	on(FieldInfo... value)	Appends the fields that this annotation applies to.
XmlAnnotation.Builder	on(MethodInfo... value)	Appends the methods that this annotation applies to.
XmlAnnotation.Builder	onClass(Class<?>... value)	Appends the classes that this annotation applies to.
XmlAnnotation.Builder	onClass(ClassInfo... value)	Appends the classes that this annotation applies to.
XmlAnnotation.Builder	prefix(String value)	Sets the Xml.prefix() 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 Xml build()

Instantiates a new @Xml object initialized with this builder.

Returns:

A new @Xml object.

description

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

Sets the description property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

childName

public XmlAnnotation.Builder childName(String value)

Sets the Xml.childName() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

format

public XmlAnnotation.Builder format(XmlFormat value)

Sets the Xml.format() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

namespace

public XmlAnnotation.Builder namespace(String value)

Sets the Xml.namespace() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

prefix

public XmlAnnotation.Builder prefix(String value)

Sets the Xml.prefix() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

on

public XmlAnnotation.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 XmlAnnotation.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 XmlAnnotation.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 XmlAnnotation.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 XmlAnnotation.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 XmlAnnotation.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 XmlAnnotation.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 XmlAnnotation.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 XmlAnnotation.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.