Package security.whisper.javastix.custom.objects

Class CustomObject.Builder

java.lang.Object
security.whisper.javastix.custom.objects.CustomObject.Builder
Enclosing class:
CustomObject
@NotThreadSafe public static final class CustomObject.Builder extends Object
Builds instances of type CustomObject. 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 Details

    • from

      @CanIgnoreReturnValue public final CustomObject.Builder from(BundleableObject instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.bundle.BundleableObject instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final CustomObject.Builder from(StixCommonProperties instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.common.StixCommonProperties instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final CustomObject.Builder from(StixRevoked instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.common.StixRevoked instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final CustomObject.Builder from(StixCustomObject instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.custom.StixCustomObject instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final CustomObject.Builder from(StixLabels instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.common.StixLabels instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final CustomObject.Builder from(StixModified instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.common.StixModified instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final CustomObject.Builder from(GenericCustomObject instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.custom.objects.GenericCustomObject instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • type

      @CanIgnoreReturnValue public final CustomObject.Builder type(@StartsWith("x-") String type)
      Initializes the value for the type attribute.
      Parameters:
      type - The value for type (can be null)
      Returns:
      this builder for use in a chained invocation

    • id

      @CanIgnoreReturnValue public final CustomObject.Builder id(@StartsWith("x-") String id)
      Initializes the value for the id attribute.
      Parameters:
      id - The value for id (can be null)
      Returns:
      this builder for use in a chained invocation

    • putCustomObjectProperty

      @CanIgnoreReturnValue public final CustomObject.Builder putCustomObjectProperty(String key, Object value)
      Put one entry to the customObjectProperties map.
      Parameters:
      key - The key in the customObjectProperties map
      value - The associated value in the customObjectProperties map
      Returns:
      this builder for use in a chained invocation

    • putCustomObjectProperty

      @CanIgnoreReturnValue public final CustomObject.Builder putCustomObjectProperty(Map.Entry<String,? extends Object> entry)
      Put one entry to the customObjectProperties map. Nulls are not permitted
      Parameters:
      entry - The key and value entry
      Returns:
      this builder for use in a chained invocation

    • customObjectProperties

      @CanIgnoreReturnValue public final CustomObject.Builder customObjectProperties(Map<String,? extends Object> entries)
      Sets or replaces all mappings from the specified map as entries for the customObjectProperties map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the customObjectProperties map
      Returns:
      this builder for use in a chained invocation

    • putAllCustomObjectProperties

      @CanIgnoreReturnValue public final CustomObject.Builder putAllCustomObjectProperties(Map<String,? extends Object> entries)
      Put all mappings from the specified map as entries to customObjectProperties map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the customObjectProperties map
      Returns:
      this builder for use in a chained invocation

    • hydrated

      @CanIgnoreReturnValue public final CustomObject.Builder hydrated(boolean hydrated)
      Initializes the value for the hydrated attribute.

      If not set, this attribute will have a default value as returned by the initializer of hydrated.

      Parameters:
      hydrated - The value for hydrated
      Returns:
      this builder for use in a chained invocation

    • createdByRef

      @CanIgnoreReturnValue public final CustomObject.Builder createdByRef(IdentitySdo createdByRef)
      Initializes the optional value createdByRef to createdByRef.
      Parameters:
      createdByRef - The value for createdByRef
      Returns:
      this builder for chained invocation

    • createdByRef

      @CanIgnoreReturnValue @JsonPropertyDescription("Represents identifiers across the CTI specifications. The format consists of the name of the top-level object being identified, followed by two dashes (--), followed by a UUIDv4.") public final CustomObject.Builder createdByRef(Optional<? extends IdentitySdo> createdByRef)
      Initializes the optional value createdByRef to createdByRef.
      Parameters:
      createdByRef - The value for createdByRef
      Returns:
      this builder for use in a chained invocation

    • created

      @CanIgnoreReturnValue @JsonPropertyDescription("The created property represents the time at which the first version of this object was created. The timstamp value MUST be precise to the nearest millisecond.") public final CustomObject.Builder created(StixInstant created)
      Initializes the value for the created attribute.

      If not set, this attribute will have a default value as returned by the initializer of created.

      Parameters:
      created - The value for created
      Returns:
      this builder for use in a chained invocation

    • lang

      @CanIgnoreReturnValue public final CustomObject.Builder lang(String lang)
      Initializes the optional value lang to lang.
      Parameters:
      lang - The value for lang
      Returns:
      this builder for chained invocation

    • lang

      @CanIgnoreReturnValue @JsonPropertyDescription("Identifies the language of the text content in this object using ISO 639-2 language codes.") public final CustomObject.Builder lang(Optional<String> lang)
      Initializes the optional value lang to lang.
      Parameters:
      lang - The value for lang
      Returns:
      this builder for use in a chained invocation

    • addExternalReference

      @CanIgnoreReturnValue public final CustomObject.Builder addExternalReference(@Nullable ExternalReferenceType element)
      Adds one element to externalReferences set.
      Parameters:
      element - A externalReferences element
      Returns:
      this builder for use in a chained invocation

    • addExternalReferences

      @CanIgnoreReturnValue public final CustomObject.Builder addExternalReferences(ExternalReferenceType... elements)
      Adds elements to externalReferences set.
      Parameters:
      elements - An array of externalReferences elements
      Returns:
      this builder for use in a chained invocation

    • externalReferences

      @CanIgnoreReturnValue @JsonPropertyDescription("A list of external references which refers to non-STIX information.") public final CustomObject.Builder externalReferences(Iterable<? extends ExternalReferenceType> elements)
      Sets or replaces all elements for externalReferences set.
      Parameters:
      elements - An iterable of externalReferences elements
      Returns:
      this builder for use in a chained invocation

    • addAllExternalReferences

      @CanIgnoreReturnValue public final CustomObject.Builder addAllExternalReferences(Iterable<? extends ExternalReferenceType> elements)
      Adds elements to externalReferences set.
      Parameters:
      elements - An iterable of externalReferences elements
      Returns:
      this builder for use in a chained invocation

    • addObjectMarkingRef

      @CanIgnoreReturnValue public final CustomObject.Builder addObjectMarkingRef(@Nullable MarkingDefinitionDm element)
      Adds one element to objectMarkingRefs set.
      Parameters:
      element - A objectMarkingRefs element
      Returns:
      this builder for use in a chained invocation

    • addObjectMarkingRefs

      @CanIgnoreReturnValue public final CustomObject.Builder addObjectMarkingRefs(MarkingDefinitionDm... elements)
      Adds elements to objectMarkingRefs set.
      Parameters:
      elements - An array of objectMarkingRefs elements
      Returns:
      this builder for use in a chained invocation

    • objectMarkingRefs

      @CanIgnoreReturnValue @JsonPropertyDescription("The list of marking-definition objects to be applied to this object.") public final CustomObject.Builder objectMarkingRefs(Iterable<? extends MarkingDefinitionDm> elements)
      Sets or replaces all elements for objectMarkingRefs set.
      Parameters:
      elements - An iterable of objectMarkingRefs elements
      Returns:
      this builder for use in a chained invocation

    • addAllObjectMarkingRefs

      @CanIgnoreReturnValue public final CustomObject.Builder addAllObjectMarkingRefs(Iterable<? extends MarkingDefinitionDm> elements)
      Adds elements to objectMarkingRefs set.
      Parameters:
      elements - An iterable of objectMarkingRefs elements
      Returns:
      this builder for use in a chained invocation

    • addGranularMarking

      @CanIgnoreReturnValue public final CustomObject.Builder addGranularMarking(@Nullable GranularMarkingDm element)
      Adds one element to granularMarkings set.
      Parameters:
      element - A granularMarkings element
      Returns:
      this builder for use in a chained invocation

    • addGranularMarkings

      @CanIgnoreReturnValue public final CustomObject.Builder addGranularMarkings(GranularMarkingDm... elements)
      Adds elements to granularMarkings set.
      Parameters:
      elements - An array of granularMarkings elements
      Returns:
      this builder for use in a chained invocation

    • granularMarkings

      @CanIgnoreReturnValue @JsonPropertyDescription("The set of granular markings that apply to this object.") public final CustomObject.Builder granularMarkings(Iterable<? extends GranularMarkingDm> elements)
      Sets or replaces all elements for granularMarkings set.
      Parameters:
      elements - An iterable of granularMarkings elements
      Returns:
      this builder for use in a chained invocation

    • addAllGranularMarkings

      @CanIgnoreReturnValue public final CustomObject.Builder addAllGranularMarkings(Iterable<? extends GranularMarkingDm> elements)
      Adds elements to granularMarkings set.
      Parameters:
      elements - An iterable of granularMarkings elements
      Returns:
      this builder for use in a chained invocation

    • addLabel

      @CanIgnoreReturnValue public final CustomObject.Builder addLabel(@Nullable String element)
      Adds one element to labels set.
      Parameters:
      element - A labels element
      Returns:
      this builder for use in a chained invocation

    • addLabels

      @CanIgnoreReturnValue public final CustomObject.Builder addLabels(String... elements)
      Adds elements to labels set.
      Parameters:
      elements - An array of labels elements
      Returns:
      this builder for use in a chained invocation

    • labels

      @CanIgnoreReturnValue @JsonPropertyDescription("The labels property specifies a set of classifications.") public final CustomObject.Builder labels(Iterable<String> elements)
      Sets or replaces all elements for labels set.
      Parameters:
      elements - An iterable of labels elements
      Returns:
      this builder for use in a chained invocation

    • addAllLabels

      @CanIgnoreReturnValue public final CustomObject.Builder addAllLabels(Iterable<String> elements)
      Adds elements to labels set.
      Parameters:
      elements - An iterable of labels elements
      Returns:
      this builder for use in a chained invocation

    • modified

      @CanIgnoreReturnValue @JsonPropertyDescription("The modified property represents the time that this particular version of the object was created. The timstamp value MUST be precise to the nearest millisecond.") public final CustomObject.Builder modified(StixInstant modified)
      Initializes the value for the modified attribute.

      If not set, this attribute will have a default value as returned by the initializer of modified.

      Parameters:
      modified - The value for modified
      Returns:
      this builder for use in a chained invocation

    • revoked

      @CanIgnoreReturnValue @JsonPropertyDescription("The revoked property indicates whether the object has been revoked.") public final CustomObject.Builder revoked(StixBoolean revoked)
      Initializes the value for the revoked attribute.

      If not set, this attribute will have a default value as returned by the initializer of revoked.

      Parameters:
      revoked - The value for revoked
      Returns:
      this builder for use in a chained invocation

    • build

      public CustomObject build()
      Builds a new CustomObject.
      Returns:
      An immutable instance of CustomObject
      Throws:
      IllegalStateException - if any required attributes are missing