Package org.cyclonedx

Enum Format

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Format>
    public enum Format
extends java.lang.Enum<Format>

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      JSON  
      XML  

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String extension  
      private java.lang.String mediaType  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Format​(java.lang.String extension, java.lang.String mediaType)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getExtension()
      The file extension associated to this format.
      java.lang.String getMediaType()
      The official CycloneDX media type assigned by IANA for this format, see ....
      static Format valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Format[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • XML

        public static final Format XML

      • JSON

        public static final Format JSON

    • Field Detail

      • extension

        private final java.lang.String extension

      • mediaType

        private final java.lang.String mediaType

    • Constructor Detail

      • Format

        private Format​(java.lang.String extension,
               java.lang.String mediaType)

    • Method Detail

      • values

        public static Format[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Format c : Format.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Format valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getExtension

        public java.lang.String getExtension()
        The file extension associated to this format.
        Returns:
        The file extension, excluding the dot.

      • getMediaType

        public java.lang.String getMediaType()
        The official CycloneDX media type assigned by IANA for this format, see ....
        Returns:
        The identifier for the media type.