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

Class PdfFileExtension.Builder

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

    • from

      @CanIgnoreReturnValue public final PdfFileExtension.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 PdfFileExtension.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

    • version

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

    • version

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies the decimal version number of the Optional<String> from the PDF header that specifies the version of the PDF specification to which the PDF file conforms. E.g., \'1.4\'.") public final PdfFileExtension.Builder version(Optional<String> version)
      Initializes the optional value version to version.
      Parameters:
      version - The value for version
      Returns:
      this builder for use in a chained invocation

    • isOptimized

      @CanIgnoreReturnValue public final PdfFileExtension.Builder isOptimized(boolean isOptimized)
      Initializes the optional value isOptimized to isOptimized.
      Parameters:
      isOptimized - The value for isOptimized
      Returns:
      this builder for chained invocation

    • isOptimized

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies whether the PDF file has been optimized.") public final PdfFileExtension.Builder isOptimized(Optional<Boolean> isOptimized)
      Initializes the optional value isOptimized to isOptimized.
      Parameters:
      isOptimized - The value for isOptimized
      Returns:
      this builder for use in a chained invocation

    • putDocumentInfoDict

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

    • putDocumentInfoDict

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

    • documentInfoDict

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies details of the PDF document information dictionary (DID), which includes properties like the document creation data and producer, as a dictionary.") public final PdfFileExtension.Builder documentInfoDict(Map<String,? extends String> entries)
      Sets or replaces all mappings from the specified map as entries for the documentInfoDict map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the documentInfoDict map
      Returns:
      this builder for use in a chained invocation

    • putAllDocumentInfoDict

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

    • pdfId0

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

    • pdfId0

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies the first file identifier found for the PDF file.") public final PdfFileExtension.Builder pdfId0(Optional<String> pdfId0)
      Initializes the optional value pdfId0 to pdfId0.
      Parameters:
      pdfId0 - The value for pdfId0
      Returns:
      this builder for use in a chained invocation

    • pdfId1

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

    • pdfId1

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies the second file identifier found for the PDF file.") public final PdfFileExtension.Builder pdfId1(Optional<String> pdfId1)
      Initializes the optional value pdfId1 to pdfId1.
      Parameters:
      pdfId1 - The value for pdfId1
      Returns:
      this builder for use in a chained invocation

    • type

      @CanIgnoreReturnValue public final PdfFileExtension.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 PdfFileExtension.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 PdfFileExtension.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 PdfFileExtension.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 PdfFileExtension.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 PdfFileExtension build()
      Builds a new PdfFileExtension.
      Returns:
      An immutable instance of PdfFileExtension
      Throws:
      IllegalStateException - if any required attributes are missing