Package org.odpi.openmetadata.reports.messages

Class MessageSetDescription

java.lang.Object
org.odpi.openmetadata.reports.messages.MessageSetDescription
public class MessageSetDescription extends Object
MessageSetDescription captures the content of a single message set - that is, one enum that implements one of the message set interfaces from the audit log framework.

  • Method Details

    • getEnumName

      public String getEnumName()
      Return the simple name of the message set enum.
      Returns:
      java identifier

    • getPackageName

      public String getPackageName()
      Return the java package that the message set is defined in.
      Returns:
      package name

    • getQualifiedName

      public String getQualifiedName()
      Return the fully qualified name of the message set enum.
      Returns:
      qualified class name

    • getMessageSetType

      public MessageSetType getMessageSetType()
      Return which of the message set interfaces the enum implements.
      Returns:
      message set type

    • getCategory

      public MessageSetCategory getCategory()
      Return the part of the documentation that this message set is described in.
      Returns:
      category

    • getSourcePath

      public String getSourcePath()
      Return the path of the source file, relative to the repository root.
      Returns:
      relative path, using "/" separators

    • getModulePath

      public String getModulePath()
      Return the path of the module that defines this message set, relative to the repository root.
      Returns:
      relative path, using "/" separators

    • getDescription

      public String getDescription()
      Return the text taken from the class-level javadoc of the message set.
      Returns:
      description - may be null if the message set has no class-level javadoc

    • getMessages

      public List<MessageDescription> getMessages()
      Return the message definitions, in the order that they are declared in the enum.
      Returns:
      list of message descriptions

    • getMessageIdPrefix

      public String getMessageIdPrefix()
      Return the part of the message identifier that is common to every message in this set. This is the value that someone looks up when they see a message identifier in a log or an exception. The common part is trimmed back to the last "-" so that it does not include a partial number.
      Returns:
      message identifier prefix - an empty string if the messages have nothing in common

    • getFileName

      public String getFileName()
      Return the name of the markdown file that documents this message set.
      Returns:
      file name

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style