Class ImmutableTopicData.Builder

  • Enclosing class:
    ImmutableTopicData

    @NotThreadSafe
    public static final class ImmutableTopicData.Builder
    extends Object
    Builds instances of type ImmutableTopicData. Initialize attributes and then invoke the build() method to create an immutable instance.

    Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

    • Method Detail

      • from

        @CanIgnoreReturnValue
        public final ImmutableTopicData.Builder from​(SiteVisitor.TopicData instance)
        Fill a builder with attribute values from the provided TopicData instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.
        Parameters:
        instance - The instance from which to copy values
        Returns:
        this builder for use in a chained invocation
      • path

        @CanIgnoreReturnValue
        public final ImmutableTopicData.Builder path​(String path)
        Initializes the value for the path attribute.
        Parameters:
        path - The value for path
        Returns:
        this builder for use in a chained invocation
      • locale

        @CanIgnoreReturnValue
        public final ImmutableTopicData.Builder locale​(String locale)
        Initializes the value for the locale attribute.
        Parameters:
        locale - The value for locale
        Returns:
        this builder for use in a chained invocation
      • value

        @CanIgnoreReturnValue
        public final ImmutableTopicData.Builder value​(String value)
        Initializes the value for the value attribute.
        Parameters:
        value - The value for value
        Returns:
        this builder for use in a chained invocation
      • addHeadings

        @CanIgnoreReturnValue
        public final ImmutableTopicData.Builder addHeadings​(Markdowns.Heading... elements)
        Adds elements to headings list.
        Parameters:
        elements - An array of headings elements
        Returns:
        this builder for use in a chained invocation
      • addImages

        @CanIgnoreReturnValue
        public final ImmutableTopicData.Builder addImages​(Markdowns.ImageTag... elements)
        Adds elements to images list.
        Parameters:
        elements - An array of images elements
        Returns:
        this builder for use in a chained invocation