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

Class RasterImageFileExtension

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

  • Method Details

    • getImageHeight

      @JsonPropertyDescription("Specifies the height of the image in the image file, in pixels.") public Optional<Long> getImageHeight()
      Specified by:
      getImageHeight in interface RasterImageFileExtensionExt
      Returns:
      The value of the imageHeight attribute

    • getImageWidth

      @JsonPropertyDescription("Specifies the width of the image in the image file, in pixels.") public Optional<Long> getImageWidth()
      Specified by:
      getImageWidth in interface RasterImageFileExtensionExt
      Returns:
      The value of the imageWidth attribute

    • getBitsPerPixel

      @JsonPropertyDescription("Specifies the sum of bits used for each color channel in the image in the image file, and thus the total number of pixels used for expressing the color depth of the image.") public Optional<Long> getBitsPerPixel()
      Specified by:
      getBitsPerPixel in interface RasterImageFileExtensionExt
      Returns:
      The value of the bitsPerPixel attribute

    • getImageCompressionAlgorithm

      @JsonPropertyDescription("Specifies the name of the compression algorithm used to compress the image in the image file, if applicable.") public Optional<String> getImageCompressionAlgorithm()
      Specified by:
      getImageCompressionAlgorithm in interface RasterImageFileExtensionExt
      Returns:
      The value of the imageCompressionAlgorithm attribute

    • getExifTags

      @JsonPropertyDescription("Specifies the set of EXIF tags found in the image file, as a dictionary. Each key/value pair in the dictionary represents the name/value of a single EXIF tag.") public com.google.common.collect.ImmutableMap<String,Object> getExifTags()
      Specified by:
      getExifTags in interface RasterImageFileExtensionExt
      Returns:
      The value of the exifTags 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>

    • withImageHeight

      public final RasterImageFileExtension withImageHeight(long value)
      Copy the current immutable object by setting a present value for the optional imageHeight attribute.
      Parameters:
      value - The value for imageHeight
      Returns:
      A modified copy of this object

    • withImageHeight

      public final RasterImageFileExtension withImageHeight(Optional<Long> optional)
      Copy the current immutable object by setting an optional value for the imageHeight 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 imageHeight
      Returns:
      A modified copy of this object

    • withImageWidth

      public final RasterImageFileExtension withImageWidth(long value)
      Copy the current immutable object by setting a present value for the optional imageWidth attribute.
      Parameters:
      value - The value for imageWidth
      Returns:
      A modified copy of this object

    • withImageWidth

      public final RasterImageFileExtension withImageWidth(Optional<Long> optional)
      Copy the current immutable object by setting an optional value for the imageWidth 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 imageWidth
      Returns:
      A modified copy of this object

    • withBitsPerPixel

      public final RasterImageFileExtension withBitsPerPixel(long value)
      Copy the current immutable object by setting a present value for the optional bitsPerPixel attribute.
      Parameters:
      value - The value for bitsPerPixel
      Returns:
      A modified copy of this object

    • withBitsPerPixel

      public final RasterImageFileExtension withBitsPerPixel(Optional<Long> optional)
      Copy the current immutable object by setting an optional value for the bitsPerPixel 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 bitsPerPixel
      Returns:
      A modified copy of this object

    • withImageCompressionAlgorithm

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

    • withImageCompressionAlgorithm

      public final RasterImageFileExtension withImageCompressionAlgorithm(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the imageCompressionAlgorithm 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 imageCompressionAlgorithm
      Returns:
      A modified copy of this object

    • withExifTags

      public final RasterImageFileExtension withExifTags(Map<String,? extends Object> entries)
      Copy the current immutable object by replacing the exifTags 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 exifTags map
      Returns:
      A modified copy of this object

    • withType

      public final RasterImageFileExtension 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 RasterImageFileExtension 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 RasterImageFileExtension 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: imageHeight, imageWidth, bitsPerPixel, imageCompressionAlgorithm, exifTags, type, customProperties.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static RasterImageFileExtension copyOf(RasterImageFileExtensionExt instance)
      Creates an immutable copy of a RasterImageFileExtensionExt 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 RasterImageFileExtension instance

    • builder

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