Package com.io7m.smfj.core
Class SMFFormatDescription.Builder
- java.lang.Object
-
- com.io7m.smfj.core.SMFFormatDescription.Builder
-
- Enclosing class:
- SMFFormatDescription
public static final class SMFFormatDescription.Builder extends java.lang.Object
Builds instances of typeSMFFormatDescription
. Initialize attributes and then invoke thebuild()
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SMFFormatDescription
build()
Builds a newSMFFormatDescription
.SMFFormatDescription.Builder
from(SMFFormatDescriptionType instance)
Fill a builder with attribute values from the providedSMFFormatDescriptionType
instance.SMFFormatDescription.Builder
setDescription(java.lang.String description)
Initializes the value for thedescription
attribute.SMFFormatDescription.Builder
setMimeType(java.lang.String mimeType)
Initializes the value for themimeType
attribute.SMFFormatDescription.Builder
setName(java.lang.String name)
Initializes the value for thename
attribute.SMFFormatDescription.Builder
setRandomAccess(boolean randomAccess)
Initializes the value for therandomAccess
attribute.SMFFormatDescription.Builder
setSuffix(java.lang.String suffix)
Initializes the value for thesuffix
attribute.
-
-
-
Method Detail
-
from
public final SMFFormatDescription.Builder from(SMFFormatDescriptionType instance)
Fill a builder with attribute values from the providedSMFFormatDescriptionType
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
public final SMFFormatDescription.Builder setDescription(java.lang.String description)
Initializes the value for thedescription
attribute.- Parameters:
description
- The value for description- Returns:
this
builder for use in a chained invocation
-
setSuffix
public final SMFFormatDescription.Builder setSuffix(java.lang.String suffix)
Initializes the value for thesuffix
attribute.- Parameters:
suffix
- The value for suffix- Returns:
this
builder for use in a chained invocation
-
setMimeType
public final SMFFormatDescription.Builder setMimeType(java.lang.String mimeType)
Initializes the value for themimeType
attribute.- Parameters:
mimeType
- The value for mimeType- Returns:
this
builder for use in a chained invocation
-
setName
public final SMFFormatDescription.Builder setName(java.lang.String name)
Initializes the value for thename
attribute.- Parameters:
name
- The value for name- Returns:
this
builder for use in a chained invocation
-
setRandomAccess
public final SMFFormatDescription.Builder setRandomAccess(boolean randomAccess)
Initializes the value for therandomAccess
attribute.- Parameters:
randomAccess
- The value for randomAccess- Returns:
this
builder for use in a chained invocation
-
build
public SMFFormatDescription build()
Builds a newSMFFormatDescription
.- Returns:
- An immutable instance of SMFFormatDescription
- Throws:
java.lang.IllegalStateException
- if any required attributes are missing
-
-