Package io.nosqlbench.nb.api.markdown.types

Enum DocScope

java.lang.Object
java.lang.Enum<DocScope>
io.nosqlbench.nb.api.markdown.types.DocScope
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DocScope>, java.lang.constant.Constable
public enum DocScope
extends java.lang.Enum<DocScope>
DocScope determines which display mode a topic is meant to be displayed in. You should filter for the DocScopes you are interested in when you ask for markdown content. The special values ANY and NONE are provided for two reasons:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    ANY
    ANY is a descriptive doc scope which is meant to be used as a filter within API calls to find and display docs.
    app
    The dynamic web doc scope includes any markdown which should be made available to users when they are interacting with a web application.
    cli
    The command line doc scope includes any markdown which should be shown to the user when they are searching for or viewing documentation on a command line.
    NONE
    NONE is a descriptive doc scope which is meant to be used as the default value for found raw markdown if it has not been tagged with a direct scope.
    web
    The static web doc scope includes any markdown which should be shown to the user when they are viewing documentation on an externally hosted site in static form.

  • Method Summary

    Modifier and Type Method Description
    static DocScope valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static DocScope[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • cli

      public static final DocScope cli
      The command line doc scope includes any markdown which should be shown to the user when they are searching for or viewing documentation on a command line.

    • web

      public static final DocScope web
      The static web doc scope includes any markdown which should be shown to the user when they are viewing documentation on an externally hosted site in static form.

    • app

      public static final DocScope app
      The dynamic web doc scope includes any markdown which should be made available to users when they are interacting with a web application.

    • ANY

      public static final DocScope ANY
      ANY is a descriptive doc scope which is meant to be used as a filter within API calls to find and display docs. It is invalid for any raw markdown content to be tagged with this doc scope.

    • NONE

      public static final DocScope NONE
      NONE is a descriptive doc scope which is meant to be used as the default value for found raw markdown if it has not been tagged with a direct scope. This scope should only be returned as a place holder when no scopes are defined on content. When reading raw content, finding the NONE scope explicitly on raw source is considered an error.

  • Method Details

    • values

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

    • valueOf

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