Package org.metabit.platform.interfacing.jjournal

Enum Class OpenFlags

java.lang.Object
java.lang.Enum<OpenFlags>
org.metabit.platform.interfacing.jjournal.OpenFlags
All Implemented Interfaces:
Serializable, Comparable<OpenFlags>, Constable
public enum OpenFlags extends Enum<OpenFlags>
flags for opening the Journal access. These are intended to be used in an EnumSet - multiple of these can be combined. see https://www.freedesktop.org/software/systemd/man/sd_journal_open.html# the SD_JOURNAL_ prefix is omitted here, because the enum provides the namespace.
Version:
$Id: $Id

  • Nested Class Summary

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

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ALL_NAMESPACES
    Show all namespaces, not just the default or specified one
    CURRENT_USER
    open journal files of the current user.
    INCLUDE_DEFAULT_NAMESPACE
    Show default namespace in addition to specified one
    LOCAL_ONLY
    open only journal files generated on the local machine, no remote ones.
    OS_ROOT
    journal files are searched for below the usual /var/log/journal and /run/log/journal relative to the specified path, instead of directly beneath it.
    RUNTIME_ONLY
    only volatile journal files will be opened, excluding those which are stored on persistent storage.
    SYSTEM
    open journals of system services and the kernel (as opposed to user session processes).

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    value
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    OpenFlags(int value)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    getCombinedFlagValue(EnumSet<OpenFlags> flagset)
    bitwise combine flag values to an int.
    int
    getValue()
    get the numerical value of the flag.
    static OpenFlags
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static OpenFlags[]
    values()
    Returns an array containing the constants of this enum class, 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

    • LOCAL_ONLY

      public static final OpenFlags LOCAL_ONLY
      open only journal files generated on the local machine, no remote ones.

    • RUNTIME_ONLY

      public static final OpenFlags RUNTIME_ONLY
      only volatile journal files will be opened, excluding those which are stored on persistent storage.

    • SYSTEM

      public static final OpenFlags SYSTEM
      open journals of system services and the kernel (as opposed to user session processes). If neither SD_JOURNAL_SYSTEM nor SD_JOURNAL_CURRENT_USER are specified, all journal file types will be opened.

    • CURRENT_USER

      public static final OpenFlags CURRENT_USER
      open journal files of the current user. If neither SD_JOURNAL_SYSTEM nor SD_JOURNAL_CURRENT_USER are specified, all journal file types will be opened.

    • OS_ROOT

      public static final OpenFlags OS_ROOT
      journal files are searched for below the usual /var/log/journal and /run/log/journal relative to the specified path, instead of directly beneath it.

    • ALL_NAMESPACES

      public static final OpenFlags ALL_NAMESPACES
      Show all namespaces, not just the default or specified one

    • INCLUDE_DEFAULT_NAMESPACE

      public static final OpenFlags INCLUDE_DEFAULT_NAMESPACE
      Show default namespace in addition to specified one

  • Field Details

    • value

      private final int value

  • Constructor Details

    • OpenFlags

      private OpenFlags(int value)

  • Method Details

    • values

      public static OpenFlags[] 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 OpenFlags 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

    • getValue

      public int getValue()
      get the numerical value of the flag.
      Returns:
      the numerical bit value of the flag.

    • getCombinedFlagValue

      public static int getCombinedFlagValue(EnumSet<OpenFlags> flagset)
      bitwise combine flag values to an int.
      Parameters:
      flagset - the set of flags to combine
      Returns:
      integer or-ing the numerical values of the set flag bits.