Package com.saperion.ngc.favorites

Enum Class FavoriteXmlHandler

java.lang.Object
java.lang.Enum<FavoriteXmlHandler>
com.saperion.ngc.favorites.FavoriteXmlHandler
All Implemented Interfaces:
Serializable, Comparable<FavoriteXmlHandler>, Constable
public enum FavoriteXmlHandler extends Enum<FavoriteXmlHandler>
XML Handler to perform xml to java binding.
Author:
mak

  • Enum Constant Details

  • Field Details

  • Method Details

    • values

      public static FavoriteXmlHandler[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FavoriteXmlHandler valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • unmarshal

      public com.saperion.ngc.favorites.xml.Favorites unmarshal(String xml) throws jakarta.xml.bind.JAXBException
      Converts the given favorites xml string to java binding.
      Parameters:
      xml - the favorites xml string
      Returns:
      Favorites element root
      Throws:
      jakarta.xml.bind.JAXBException - JAXBException

    • unmarshal

      public com.saperion.ngc.favorites.xml.Favorites unmarshal(InputStream stream) throws jakarta.xml.bind.JAXBException
      Converts the given favorites xml stream to java binding.
      Parameters:
      stream - the favorites xml stream
      Returns:
      Favorites element root
      Throws:
      jakarta.xml.bind.JAXBException - JAXBException

    • getAdaptedFavorites

      public com.saperion.ngc.favorites.xml.Favorites getAdaptedFavorites(InputStream stream) throws jakarta.xml.bind.JAXBException, FavoriteReadException
      Converts the given favorites xml stream to java binding and adds additional information (converts the string data to the real data types).
      Parameters:
      stream - the favorites xml stream
      Returns:
      Favorites element root
      Throws:
      jakarta.xml.bind.JAXBException - JAXBException
      FavoriteReadException - favorite settings could not be read

    • marshal

      public String marshal(com.saperion.ngc.favorites.xml.Favorites favorites) throws jakarta.xml.bind.JAXBException
      Converts the given favorites java object to xml binding.
      Parameters:
      favorites - Favorites element root
      Returns:
      the favorites xml string
      Throws:
      jakarta.xml.bind.JAXBException - JAXBException

    • marshalToStream

      public com.saperion.rmi.SaContentStream marshalToStream(com.saperion.ngc.favorites.xml.Favorites favorites) throws jakarta.xml.bind.JAXBException
      Converts the given favorites java object to xml binding.
      Parameters:
      favorites - Favorites element root
      Returns:
      the favorites file content stream
      Throws:
      jakarta.xml.bind.JAXBException - JAXBException