Interface BodyTypeFactory


  • @Deprecated(forRemoval=true)
    public interface BodyTypeFactory
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 8.8
    Describes a factory responsible for providing a consistent and fixed set of BodyType instances to other components.
    Since:
    4.0
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      BodyType getBodyType​(String type)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return a body type which isn't one of the core types with their own direct accessor.
      BodyType getMailBodyType()
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      BodyType getWikiBodyType()
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      BodyType getXhtmlBodyType()
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      void initialiseBodyTypes()
      Deprecated, for removal: This API element is subject to removal in a future version.
      For use during setup to ensure all the necessary BodyTypes have been created.
    • Method Detail

      • initialiseBodyTypes

        void initialiseBodyTypes()
        Deprecated, for removal: This API element is subject to removal in a future version.
        For use during setup to ensure all the necessary BodyTypes have been created.
      • getXhtmlBodyType

        BodyType getXhtmlBodyType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns:
        the body type representing Xhtml.
      • getMailBodyType

        BodyType getMailBodyType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns:
        the body type representing Mail.
      • getWikiBodyType

        BodyType getWikiBodyType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns:
        the body type representing wiki markup.
      • getBodyType

        BodyType getBodyType​(String type)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Return a body type which isn't one of the core types with their own direct accessor. The BodyType matching the supplied String is returned or null if there is no BodyType matching the requested type.
        Parameters:
        type - the String representation of the BodyType required
        Returns:
        the matching BodyType or null if there is no BodyType in the system for the supplied String.