Package org.apache.juneau.html.annotation

Class HtmlAnnotation.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.html.annotation.HtmlAnnotation.Builder

Enclosing class:

HtmlAnnotation

public static class HtmlAnnotation.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
HtmlAnnotation.Builder	anchorText(String value)	Sets the Html.anchorText() property on this annotation.
Html	build()	Instantiates a new @Html object initialized with this builder.
HtmlAnnotation.Builder	description(String... value)	Sets the description property on this annotation.
HtmlAnnotation.Builder	format(HtmlFormat value)	Sets the Html.format() property on this annotation.
HtmlAnnotation.Builder	link(String value)	Sets the Html.link() property on this annotation.
HtmlAnnotation.Builder	noTableHeaders(boolean value)	Sets the Html.noTableHeaders() property on this annotation.
HtmlAnnotation.Builder	noTables(boolean value)	Sets the Html.noTables() property on this annotation.
HtmlAnnotation.Builder	on(Class<?>... value)	Appends the classes that this annotation applies to.
HtmlAnnotation.Builder	on(Field... value)	Appends the fields that this annotation applies to.
HtmlAnnotation.Builder	on(Method... value)	Appends the methods that this annotation applies to.
HtmlAnnotation.Builder	on(String... value)	The targets this annotation applies to.
HtmlAnnotation.Builder	on(ClassInfo... value)	Appends the classes that this annotation applies to.
HtmlAnnotation.Builder	on(FieldInfo... value)	Appends the fields that this annotation applies to.
HtmlAnnotation.Builder	on(MethodInfo... value)	Appends the methods that this annotation applies to.
HtmlAnnotation.Builder	onClass(Class<?>... value)	Appends the classes that this annotation applies to.
HtmlAnnotation.Builder	onClass(ClassInfo... value)	Appends the classes that this annotation applies to.
HtmlAnnotation.Builder	render(Class<? extends HtmlRender> value)	Sets the Html.render() property on this annotation.
HtmlAnnotation.Builder	style(String value)	Sets the Html.style() 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

anchorText

public HtmlAnnotation.Builder anchorText(String value)

Sets the Html.anchorText() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

build

public Html build()

Instantiates a new @Html object initialized with this builder.

Returns:

A new @Html object.

description

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

Sets the description property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

format

public HtmlAnnotation.Builder format(HtmlFormat value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

link

public HtmlAnnotation.Builder link(String value)

Sets the Html.link() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

noTableHeaders

public HtmlAnnotation.Builder noTableHeaders(boolean value)

Sets the Html.noTableHeaders() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

noTables

public HtmlAnnotation.Builder noTables(boolean value)

Sets the Html.noTables() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

render

public HtmlAnnotation.Builder render(Class<? extends HtmlRender> value)

Sets the Html.render() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

style

public HtmlAnnotation.Builder style(String value)

Sets the Html.style() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

on

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