Class DocumentationUtils

java.lang.Object
software.amazon.awssdk.codegen.internal.DocumentationUtils
public final class DocumentationUtils extends Object

  • Method Details

    • stripHtmlTags

      public static String stripHtmlTags(String documentation)
      Returns a documentation with HTML tags prefixed and suffixed removed, or returns empty string if the input is empty or null. This method is to be used when constructing documentation for method parameters.
      Parameters:
      documentation - unprocessed input documentation
      Returns:
      HTML tag stripped documentation or empty string if input was null.

    • escapeIllegalCharacters

      public static String escapeIllegalCharacters(String documentation)
      Escapes Java comment breaking illegal character sequences.
      Parameters:
      documentation - unprocessed input documentation
      Returns:
      escaped documentation, or empty string if input was null

    • createLinkToServiceDocumentation

      public static String createLinkToServiceDocumentation(Metadata metadata, String name)
      Create the HTML for a link to the operation/shape core AWS docs site
      Parameters:
      metadata - the UID for the service from that services metadata
      name - the name of the shape/request/operation
      Returns:
      a '@see also' HTML link to the doc

    • createLinkToServiceDocumentation

      public static String createLinkToServiceDocumentation(Metadata metadata, ShapeModel shapeModel)
      Create the HTML for a link to the operation/shape core AWS docs site
      Parameters:
      metadata - the UID for the service from that services metadata
      shapeModel - the model of the shape
      Returns:
      a '@see also' HTML link to the doc

    • removeFromEnd

      public static String removeFromEnd(String string, String stringToRemove)

    • defaultSetter

      public static String defaultSetter()

    • defaultSetterParam

      public static String defaultSetterParam()

    • defaultGetter

      public static String defaultGetter()

    • defaultGetterParam

      public static String defaultGetterParam()

    • defaultFluentReturn

      public static String defaultFluentReturn()

    • defaultExistenceCheck

      public static String defaultExistenceCheck()