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

Class RasterImageFileExtension.Builder

java.lang.Object
security.whisper.javastix.coo.extension.types.RasterImageFileExtension.Builder
Enclosing class:
RasterImageFileExtension
@NotThreadSafe public static final class RasterImageFileExtension.Builder extends Object
Builds instances of type RasterImageFileExtension. 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 RasterImageFileExtension.Builder from(StixCustomProperties instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.common.StixCustomProperties instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

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

    • from

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

    • imageHeight

      @CanIgnoreReturnValue public final RasterImageFileExtension.Builder imageHeight(long imageHeight)
      Initializes the optional value imageHeight to imageHeight.
      Parameters:
      imageHeight - The value for imageHeight
      Returns:
      this builder for chained invocation

    • imageHeight

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies the height of the image in the image file, in pixels.") public final RasterImageFileExtension.Builder imageHeight(Optional<Long> imageHeight)
      Initializes the optional value imageHeight to imageHeight.
      Parameters:
      imageHeight - The value for imageHeight
      Returns:
      this builder for use in a chained invocation

    • imageWidth

      @CanIgnoreReturnValue public final RasterImageFileExtension.Builder imageWidth(long imageWidth)
      Initializes the optional value imageWidth to imageWidth.
      Parameters:
      imageWidth - The value for imageWidth
      Returns:
      this builder for chained invocation

    • imageWidth

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies the width of the image in the image file, in pixels.") public final RasterImageFileExtension.Builder imageWidth(Optional<Long> imageWidth)
      Initializes the optional value imageWidth to imageWidth.
      Parameters:
      imageWidth - The value for imageWidth
      Returns:
      this builder for use in a chained invocation

    • bitsPerPixel

      @CanIgnoreReturnValue public final RasterImageFileExtension.Builder bitsPerPixel(long bitsPerPixel)
      Initializes the optional value bitsPerPixel to bitsPerPixel.
      Parameters:
      bitsPerPixel - The value for bitsPerPixel
      Returns:
      this builder for chained invocation

    • bitsPerPixel

      @CanIgnoreReturnValue @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 final RasterImageFileExtension.Builder bitsPerPixel(Optional<Long> bitsPerPixel)
      Initializes the optional value bitsPerPixel to bitsPerPixel.
      Parameters:
      bitsPerPixel - The value for bitsPerPixel
      Returns:
      this builder for use in a chained invocation

    • imageCompressionAlgorithm

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

    • imageCompressionAlgorithm

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies the name of the compression algorithm used to compress the image in the image file, if applicable.") public final RasterImageFileExtension.Builder imageCompressionAlgorithm(Optional<String> imageCompressionAlgorithm)
      Initializes the optional value imageCompressionAlgorithm to imageCompressionAlgorithm.
      Parameters:
      imageCompressionAlgorithm - The value for imageCompressionAlgorithm
      Returns:
      this builder for use in a chained invocation

    • putExifTag

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

    • putExifTag

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

    • exifTags

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

    • putAllExifTags

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

    • type

      @CanIgnoreReturnValue public final RasterImageFileExtension.Builder type(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

    • putCustomProperty

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

    • putCustomProperty

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

    • customProperties

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

    • putAllCustomProperties

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

    • build

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