Class Source
- java.lang.Object
-
- org.apache.logging.log4j.core.util.Source
-
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 newSource
with the specified file.Source(URI uri)
Constructs a newSource
from the specified URI.Source(URI uri, long lastModified)
Deprecated.UseSource(URI)
.Source(URL url)
Constructs a newSource
from the specified URL.Source(Path path)
Constructs a newSource
from the specified Path.Source(ConfigurationSource source)
Constructs a Source from a ConfigurationSource.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
File
getFile()
Gets the file configuration source, ornull
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, ornull
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, ornull
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()
-
-
-
Constructor Detail
-
Source
public Source(ConfigurationSource source)
Constructs a Source from a ConfigurationSource.- Parameters:
source
- The ConfigurationSource.
-
Source
public Source(File file)
Constructs a newSource
with the specified file. file.- Parameters:
file
- the file where the input stream originated
-
Source
public Source(Path path)
Constructs a newSource
from the specified Path.- Parameters:
path
- the Path where the input stream originated
-
Source
public Source(URI uri)
Constructs a newSource
from the specified URI.- Parameters:
uri
- the URI where the input stream originated
-
Source
@Deprecated public Source(URI uri, long lastModified)
Deprecated.UseSource(URI)
.Constructs a newSource
from the specified URI.- Parameters:
uri
- the URI where the input stream originatedlastModified
- Not used.
-
Source
public Source(URL url)
Constructs a newSource
from the specified URL.- Parameters:
url
- the URL where the input stream originated- Throws:
IllegalArgumentException
- if this URL is not formatted strictly according to to RFC2396 and cannot be converted to a URI.
-
-
Method Detail
-
getFile
public File getFile()
Gets the file configuration source, ornull
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, ornull
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, ornull
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
-
-