Package org.apache.felix.inventory

Class Format

java.lang.Object
org.apache.felix.inventory.Format
public final class Format extends Object
Java 1.4 compatible enumeration of formats used for inventory printing.

InventoryPrinter services indicate supported formats listing any of these values in their InventoryPrinter.FORMAT service properties.

Requestors of inventory printing indicate the desired output format by specifying the respective constant when calling the InventoryPrinter.print(java.io.PrintWriter, Format, boolean) method.

Round-tripping is guaranteed between the toString() and valueOf(String) methods.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static Format
    HTML
    Inventory is printed in HTML format.
    static Format
    JSON
    Inventory is printed in JSON format.
    static Format
    TEXT
    Inventory is printed in plain text format.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    toString()
    Returns the string value of this format.
    static Format
    valueOf(String format)
    Converts the given format string into an instance of this class.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • TEXT

      public static Format TEXT
      Inventory is printed in plain text format.

    • HTML

      public static Format HTML
      Inventory is printed in HTML format.

      Technically the output is expected to be an HTML fragment which is intended to be inserted into any block element, such as <div>, within a HTML <body>.

    • JSON

      public static Format JSON
      Inventory is printed in JSON format.

      The output is expected to be a valid JSON object. That is, the output must start with an opening curly brace ({) and end with a closing curly brace (}).

  • Method Details

    • valueOf

      public static Format valueOf(String format)
      Converts the given format string into an instance of this class.
      Parameters:
      format - The string value to be converted into a Format.
      Returns:
      One of the defined Format constants or null.

    • toString

      public String toString()
      Returns the string value of this format.
      Overrides:
      toString in class Object