Class ConfigurationInfo

java.lang.Object
jdk.management.jfr.ConfigurationInfo
public final class ConfigurationInfo extends Object
Management representation of a Configuration.
Since:
9
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    static ConfigurationInfo
    from(CompositeData cd)
    Returns a ConfigurationInfo object represented by the specified CompositeData.
    String
    getContents()
    Returns the textual representation of the configuration associated with this ConfigurationInfo, typically the contents of the configuration file that was used to create the configuration.
    String
    getDescription()
    Returns a short sentence that describes the configuration associated with this ConfigurationInfo (for example, "Low overhead configuration safe for continuous use in production environments".
    String
    getLabel()
    Returns the human-readable name (for example, "Continuous" or "Profiling") for the configuration associated with this ConfigurationInfo
    String
    getName()
    Returns the name of the configuration associated with this ConfigurationInfo (for example, "default").
    String
    getProvider()
    Returns the provider of the configuration associated with this ConfigurationInfo (for example, "OpenJDK").
    Map<String,String>
    getSettings()
    Returns the settings for the configuration associated with this ConfigurationInfo.
    String
    toString()
    Returns a description of the configuration that is associated with this ConfigurationInfo.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Method Details

    • getProvider

      public String getProvider()
      Returns the provider of the configuration associated with this ConfigurationInfo (for example, "OpenJDK").
      Returns:
      the provider, or null if doesn't exist
      See Also:

    • getContents

      public String getContents()
      Returns the textual representation of the configuration associated with this ConfigurationInfo, typically the contents of the configuration file that was used to create the configuration.
      Returns:
      contents, or null if doesn't exist
      See Also:

    • getSettings

      public Map<String,String> getSettings()
      Returns the settings for the configuration associated with this ConfigurationInfo.
      Returns:
      a Map with settings, not null
      See Also:

    • getLabel

      public String getLabel()
      Returns the human-readable name (for example, "Continuous" or "Profiling") for the configuration associated with this ConfigurationInfo
      Returns:
      the label, or null if doesn't exist
      See Also:

    • getName

      public String getName()
      Returns the name of the configuration associated with this ConfigurationInfo (for example, "default").
      Returns:
      the name, or null if doesn't exist
      See Also:

    • getDescription

      public String getDescription()
      Returns a short sentence that describes the configuration associated with this ConfigurationInfo (for example, "Low overhead configuration safe for continuous use in production environments".
      Returns:
      the description, or null if doesn't exist

    • from

      public static ConfigurationInfo from(CompositeData cd)
      Returns a ConfigurationInfo object represented by the specified CompositeData.

      The following table shows the required attributes that the specified CompositeData must contain.

      Required names and types for CompositeData
      Name Type
      name String
      label String
      description String
      provider String
      contents String
      settings javax.management.openmbean.TabularData with a TabularType with the keys "key" and "value", both of the String type
      Parameters:
      cd - CompositeData representing a ConfigurationInfo
      Returns:
      a ConfigurationInfo object represented by cd if cd is not null, null otherwise
      Throws:
      IllegalArgumentException - if cd does not represent a ConfigurationInfo with the required attributes

    • toString

      public String toString()
      Returns a description of the configuration that is associated with this ConfigurationInfo.
      Overrides:
      toString in class Object
      Returns:
      the description of the configuration, not null