Package org.apache.logging.log4j.core.util

Class Source

java.lang.Object
org.apache.logging.log4j.core.util.Source
@NullMarked public class Source extends Object
Represents the source for the logging configuration as an immutable object.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Source(File file)
    Constructs a new Source with the specified file.
    Source(URI uri)
    Constructs a new Source from the specified URI.
    Source(URI uri, long ignored)
    Deprecated.
    Use Source(URI).
    Source(URL url)
    Constructs a new Source from the specified URL.
    Source(Path path)
    Constructs a new Source from the specified Path.
    Source(ConfigurationSource source)
    Constructs a Source from a ConfigurationSource.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    @Nullable File
    getFile()
    Gets the file configuration source, or null if this configuration source is based on an URL or has neither a file nor an URL.
    String
    getLocation()
    Gets a string describing the configuration source file or URI, or null if this configuration source has neither a file nor an URI.
    Path
    getPath()
    Gets this source as a Path.
    URI
    getURI()
    Gets the configuration source URI, or null if this configuration source is based on a file or has neither a file nor an URI.
    URL
    getURL()
    Gets the configuration source URL.
    int
    hashCode()
     
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Source

      public Source(ConfigurationSource source)
      Constructs a Source from a ConfigurationSource.
      Parameters:
      source - The ConfigurationSource.
      Throws:
      NullPointerException - if source is null.

    • Source

      public Source(File file)
      Constructs a new Source with the specified file. file.
      Parameters:
      file - the file where the input stream originated.
      Throws:
      NullPointerException - if file is null.

    • Source

      public Source(Path path)
      Constructs a new Source from the specified Path.
      Parameters:
      path - the Path where the input stream originated
      Throws:
      NullPointerException - if path is null.

    • Source

      public Source(URI uri)
      Constructs a new Source from the specified URI.
      Parameters:
      uri - the URI where the input stream originated
      Throws:
      NullPointerException - if uri is null.

    • Source

      @Deprecated public Source(URI uri, long ignored)
      Deprecated.
      Use Source(URI).
      Constructs a new Source from the specified URI.
      Parameters:
      uri - the URI where the input stream originated
      ignored - Not used.
      Throws:
      NullPointerException - if uri is null.

    • Source

      public Source(URL url)
      Constructs a new Source from the specified URL.
      Parameters:
      url - the URL where the input stream originated
      Throws:
      NullPointerException - if this URL is null.
      IllegalArgumentException - if this URL is not formatted strictly according to RFC2396 and cannot be converted to a URI.

  • Method Details

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • getFile

      public @Nullable File getFile()
      Gets the file configuration source, or null if this configuration source is based on an URL or has neither a file nor an URL.
      Returns:
      the configuration source file, or null

    • getLocation

      public String getLocation()
      Gets a string describing the configuration source file or URI, or null if this configuration source has neither a file nor an URI.
      Returns:
      a string describing the configuration source file or URI, or null

    • getPath

      public Path getPath()
      Gets this source as a Path.
      Returns:
      this source as a Path.

    • getURI

      public URI getURI()
      Gets the configuration source URI, or null if this configuration source is based on a file or has neither a file nor an URI.
      Returns:
      the configuration source URI, or null

    • getURL

      public URL getURL()
      Gets the configuration source URL.
      Returns:
      the configuration source URI, or null

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object