AbstractBuildableComponent.AbstractBuilder (text 1.12-1.6.5 API)

java.lang.Object
- net.kyori.text.AbstractBuildableComponent.AbstractBuilder<C,B>

Type Parameters:

C - the component type

B - the builder type

All Implemented Interfaces:

BuildableComponent.Builder<C,B>

Direct Known Subclasses:

KeybindComponent.Builder, ScoreComponent.Builder, SelectorComponent.Builder, TextComponent.Builder, TranslatableComponent.Builder

Enclosing class:

AbstractBuildableComponent<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
```
protected abstract static class AbstractBuildableComponent.AbstractBuilder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
extends java.lang.Object
implements BuildableComponent.Builder<C,B>
```
An abstract implementation of a component builder.

Field Summary

Fields
Modifier and Type	Field and Description
`protected TextDecoration.State`	`bold` If this component should have the `bold` decoration.
`protected @NonNull java.util.List<Component>`	`children` The list of children.
`protected @Nullable ClickEvent`	`clickEvent` The click event to apply to this component.
`protected @Nullable TextColor`	`color` The color of this component.
`protected @Nullable HoverEvent`	`hoverEvent` The hover event to apply to this component.
`protected @Nullable java.lang.String`	`insertion` The string to insert when this component is shift-clicked in chat.
`protected TextDecoration.State`	`italic` If this component should have the `italic` decoration.
`protected TextDecoration.State`	`obfuscated` If this component should have the `obfuscated` decoration.
`protected TextDecoration.State`	`strikethrough` If this component should have the `strikethrough` decoration.
`protected TextDecoration.State`	`underlined` If this component should have the `underlined` decoration.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractBuilder()

protected AbstractBuilder(C component)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractBuilder()`
`protected`	`AbstractBuilder(C component)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`B`	`append(@NonNull Component component)` Appends a component to this component.
`B`	`append(@NonNull java.lang.Iterable<? extends Component> components)` Appends components to this component.
`B`	`applyDeep(@NonNull java.util.function.Consumer<BuildableComponent.Builder<?,?>> consumer)` Applies an action to this component and all child components if they are an instance of `BuildableComponent`.
`B`	`clickEvent(@Nullable ClickEvent event)` Sets the click event of this component.
`B`	`color(@Nullable TextColor color)` Sets the color of this component.
`B`	`colorIfAbsent(@Nullable TextColor color)` Sets the color of this component if there isn't one set already.
`B`	`decoration(@NonNull TextDecoration decoration, TextDecoration.State state)` Sets the value of a decoration on this component.
`B`	`hoverEvent(@Nullable HoverEvent event)` Sets the hover event of this component.
`B`	`insertion(@Nullable java.lang.String insertion)` Sets the string to be inserted when this component is shift-clicked.
`B`	`mapChildren(@NonNull java.util.function.Function<BuildableComponent<?,?>,BuildableComponent<?,?>> function)` Replaces each child of this component with the resultant component from the function.
`B`	`mapChildrenDeep(@NonNull java.util.function.Function<BuildableComponent<?,?>,BuildableComponent<?,?>> function)` Replaces each child and sub-child of this component with the resultant component of the function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.kyori.text.BuildableComponent.Builder
apply, build, decoration, decorations, mergeColor, mergeDecorations, mergeEvents, mergeStyle, resetStyle

- Field Detail
  - children
```
protected @NonNull java.util.List<Component> children
```
    The list of children.
    This list is set to an empty list of components by default to prevent unnecessary list creation for components with no children.
  - color
```
protected @Nullable TextColor color
```
    The color of this component.
  - obfuscated
```
protected TextDecoration.State obfuscated
```
    If this component should have the obfuscated decoration.
  - bold
```
protected TextDecoration.State bold
```
    If this component should have the bold decoration.
  - strikethrough
```
protected TextDecoration.State strikethrough
```
    If this component should have the strikethrough decoration.
  - underlined
```
protected TextDecoration.State underlined
```
    If this component should have the underlined decoration.
  - italic
```
protected TextDecoration.State italic
```
    If this component should have the italic decoration.
  - clickEvent
```
protected @Nullable ClickEvent clickEvent
```
    The click event to apply to this component.
  - hoverEvent
```
protected @Nullable HoverEvent hoverEvent
```
    The hover event to apply to this component.
  - insertion
```
protected @Nullable java.lang.String insertion
```
    The string to insert when this component is shift-clicked in chat.
- Constructor Detail
  - AbstractBuilder
```
protected AbstractBuilder()
```
  - AbstractBuilder
```
protected AbstractBuilder(C component)
```
- Method Detail
  - append
```
public B append(@NonNull Component component)
```
    Description copied from interface: BuildableComponent.Builder
    
    Appends a component to this component.
    
    Specified by:
    
    append in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    component - the component to append
    
    Returns:
    
    this builder
  - append
```
public B append(@NonNull java.lang.Iterable<? extends Component> components)
```
    Description copied from interface: BuildableComponent.Builder
    
    Appends components to this component.
    
    Specified by:
    
    append in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    components - the components to append
    
    Returns:
    
    this builder
  - applyDeep
```
public B applyDeep(@NonNull java.util.function.Consumer<BuildableComponent.Builder<?,?>> consumer)
```
    Description copied from interface: BuildableComponent.Builder
    
    Applies an action to this component and all child components if they are an instance of BuildableComponent.
    
    Specified by:
    
    applyDeep in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    consumer - the action
    
    Returns:
    
    this builder
  - mapChildren
```
public B mapChildren(@NonNull java.util.function.Function<BuildableComponent<?,?>,BuildableComponent<?,?>> function)
```
    Description copied from interface: BuildableComponent.Builder
    
    Replaces each child of this component with the resultant component from the function.
    
    Specified by:
    
    mapChildren in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    function - the mapping function
    
    Returns:
    
    this builder
  - mapChildrenDeep
```
public B mapChildrenDeep(@NonNull java.util.function.Function<BuildableComponent<?,?>,BuildableComponent<?,?>> function)
```
    Description copied from interface: BuildableComponent.Builder
    
    Replaces each child and sub-child of this component with the resultant component of the function.
    
    Specified by:
    
    mapChildrenDeep in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    function - the mapping function
    
    Returns:
    
    this builder
  - color
```
public B color(@Nullable TextColor color)
```
    Description copied from interface: BuildableComponent.Builder
    
    Sets the color of this component.
    
    Specified by:
    
    color in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    color - the color
    
    Returns:
    
    this builder
  - colorIfAbsent
```
public B colorIfAbsent(@Nullable TextColor color)
```
    Description copied from interface: BuildableComponent.Builder
    
    Sets the color of this component if there isn't one set already.
    
    Specified by:
    
    colorIfAbsent in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    color - the color
    
    Returns:
    
    this builder
  - decoration
```
public B decoration(@NonNull TextDecoration decoration,
                    TextDecoration.State state)
```
    Description copied from interface: BuildableComponent.Builder
    
    Sets the value of a decoration on this component.
    
    Specified by:
    
    decoration in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    decoration - the decoration
    
    state - TextDecoration.State#TRUE if this component should have the decoration, TextDecoration.State#FALSE if this component should not have the decoration, and TextDecoration.State#NOT_SET if the decoration should not have a set value
    
    Returns:
    
    this builder
  - clickEvent
```
public B clickEvent(@Nullable ClickEvent event)
```
    Description copied from interface: BuildableComponent.Builder
    
    Sets the click event of this component.
    
    Specified by:
    
    clickEvent in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    event - the click event
    
    Returns:
    
    this builder
  - hoverEvent
```
public B hoverEvent(@Nullable HoverEvent event)
```
    Description copied from interface: BuildableComponent.Builder
    
    Sets the hover event of this component.
    
    Specified by:
    
    hoverEvent in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    event - the hover event
    
    Returns:
    
    this builder
  - insertion
```
public B insertion(@Nullable java.lang.String insertion)
```
    Description copied from interface: BuildableComponent.Builder
    
    Sets the string to be inserted when this component is shift-clicked.
    
    Specified by:
    
    insertion in interface BuildableComponent.Builder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>
    
    Parameters:
    
    insertion - the insertion string
    
    Returns:
    
    this builder

Class AbstractBuildableComponent.AbstractBuilder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.kyori.text.BuildableComponent.Builder

Field Detail

children

color

obfuscated

bold

strikethrough

underlined

italic

clickEvent

hoverEvent

insertion

Constructor Detail

AbstractBuilder

AbstractBuilder

Method Detail

append

append

applyDeep

mapChildren

mapChildrenDeep

color

colorIfAbsent

decoration

clickEvent

hoverEvent

insertion