Package security.whisper.javastix.coo.extension.types

Class ArchiveFileExtension

java.lang.Object
security.whisper.javastix.coo.extension.types.ArchiveFileExtension
All Implemented Interfaces:
Serializable, StixCustomProperties, CyberObservableExtension, CyberObservableExtensionCommonProperties, ArchiveFileExtensionExt, GenericValidation, SdoDefaultValidator
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue @AllowedParents(FileCoo.class) public final class ArchiveFileExtension extends Object implements ArchiveFileExtensionExt, Serializable
The Archive File extension specifies a default extension for capturing properties specific to archive files.
See Also:

  • Method Details

    • getVersion

      @JsonPropertyDescription("Specifies the version of the archive type used in the archive file.") public Optional<String> getVersion()
      Specified by:
      getVersion in interface ArchiveFileExtensionExt
      Returns:
      The value of the version attribute

    • getComment

      @JsonPropertyDescription("Specifies a comment included as part of the archive file.") public Optional<String> getComment()
      Specified by:
      getComment in interface ArchiveFileExtensionExt
      Returns:
      The value of the comment attribute

    • getType

      public String getType()
      This property is used for generation of the dictionary during serialization, and used as the "Type" mapping value for polymorphic when deserializing.
      Specified by:
      getType in interface CyberObservableExtensionCommonProperties

    • getCustomProperties

      public com.google.common.collect.ImmutableMap<String,Object> getCustomProperties()
      Custom Properties for STIX Objects. Any object that supports custom properties will have a validation of the custom property prefix (typically "x_"). If the additional property in the JSON does not meet the StartsWith condition, then the JSON will be rejected.
      Specified by:
      getCustomProperties in interface StixCustomProperties
      Returns:
      Map of custom properties Map<String, Object>

    • withVersion

      public final ArchiveFileExtension withVersion(String value)
      Copy the current immutable object by setting a present value for the optional version attribute.
      Parameters:
      value - The value for version
      Returns:
      A modified copy of this object

    • withVersion

      public final ArchiveFileExtension withVersion(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the version attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for version
      Returns:
      A modified copy of this object

    • withComment

      public final ArchiveFileExtension withComment(String value)
      Copy the current immutable object by setting a present value for the optional comment attribute.
      Parameters:
      value - The value for comment
      Returns:
      A modified copy of this object

    • withComment

      public final ArchiveFileExtension withComment(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the comment attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for comment
      Returns:
      A modified copy of this object

    • withType

      public final ArchiveFileExtension withType(String value)
      Copy the current immutable object by setting a value for the type attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for type (can be null)
      Returns:
      A modified copy of the this object

    • withCustomProperties

      public final ArchiveFileExtension withCustomProperties(Map<String,? extends Object> entries)
      Copy the current immutable object by replacing the customProperties map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      entries - The entries to be added to the customProperties map
      Returns:
      A modified copy of this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ArchiveFileExtension that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: version, comment, type, customProperties.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value ArchiveFileExtension with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static ArchiveFileExtension copyOf(ArchiveFileExtensionExt instance)
      Creates an immutable copy of a ArchiveFileExtensionExt value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable ArchiveFileExtension instance

    • builder

      public static ArchiveFileExtension.Builder builder()
      Creates a builder for ArchiveFileExtension.
      Returns:
      A new ArchiveFileExtension builder