Class FormatDescription.Builder
java.lang.Object
com.io7m.coffeepick.runtime.parser.spi.FormatDescription.Builder
- Enclosing class:
- FormatDescription
public static final class FormatDescription.Builder
extends java.lang.Object
Builds instances of type
FormatDescription
.
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 Summary
Modifier and Type Method Description FormatDescription
build()
Builds a newFormatDescription
.FormatDescription.Builder
from(FormatDescriptionType instance)
Fill a builder with attribute values from the providedFormatDescriptionType
instance.FormatDescription.Builder
setDescription(java.lang.String description)
Initializes the value for thedescription
attribute.FormatDescription.Builder
setMimeType(java.lang.String mimeType)
Initializes the value for themimeType
attribute.FormatDescription.Builder
setName(java.net.URI name)
Initializes the value for thename
attribute.
-
Method Details
-
from
Fill a builder with attribute values from the providedFormatDescriptionType
instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.- Parameters:
instance
- The instance from which to copy values- Returns:
this
builder for use in a chained invocation
-
setDescription
Initializes the value for thedescription
attribute.- Parameters:
description
- The value for description- Returns:
this
builder for use in a chained invocation
-
setMimeType
Initializes the value for themimeType
attribute.- Parameters:
mimeType
- The value for mimeType- Returns:
this
builder for use in a chained invocation
-
setName
Initializes the value for thename
attribute.- Parameters:
name
- The value for name- Returns:
this
builder for use in a chained invocation
-
build
Builds a newFormatDescription
.- Returns:
- An immutable instance of FormatDescription
- Throws:
java.lang.IllegalStateException
- if any required attributes are missing
-