org.eclipse.jgit.util

Class SystemReader

java.lang.Object

org.eclipse.jgit.util.SystemReader

Direct Known Subclasses:

MockSystemReader, SystemReader.Default

public abstract class SystemReader
extends java.lang.Object

Interface to read values from the system.

When writing unit tests, extending this interface with a custom class permits to simulate an access to a system variable or property and permits to control the user's global configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SystemReader.Default

Field Summary

Fields

Modifier and Type	Field and Description
private static SystemReader	DEFAULT
private static SystemReader	INSTANCE
private static java.lang.Boolean	isMacOS
private static java.lang.Boolean	isWindows
private ObjectChecker	platformChecker

Constructor Summary

Constructors

Constructor and Description
SystemReader()

Method Summary

Modifier and Type	Method and Description
void	checkPath(byte[] path) Check tree path entry for validity.
void	checkPath(java.lang.String path) Check tree path entry for validity.
MonotonicClock	getClock() Get clock instance preferred by this system.
abstract long	getCurrentTime() Get the current system time
java.text.DateFormat	getDateTimeInstance(int dateStyle, int timeStyle) Returns a date/time format instance for the given styles.
abstract java.lang.String	getenv(java.lang.String variable) Get value of the system variable
abstract java.lang.String	getHostname() Gets the hostname of the local host.
static SystemReader	getInstance() Get time since epoch, with up to millisecond resolution.
java.util.Locale	getLocale() Get the locale to use
private java.lang.String	getOsName()
abstract java.lang.String	getProperty(java.lang.String key) Get value of the system property
java.text.SimpleDateFormat	getSimpleDateFormat(java.lang.String pattern) Returns a simple date format instance as specified by the given pattern.
java.text.SimpleDateFormat	getSimpleDateFormat(java.lang.String pattern, java.util.Locale locale) Returns a simple date format instance as specified by the given pattern.
java.util.TimeZone	getTimeZone() Get system time zone, possibly mocked for testing
abstract int	getTimezone(long when) Get the local time zone
private void	init()
boolean	isMacOS() Whether we are running on Mac OS X
boolean	isWindows() Whether we are running on Windows.
abstract FileBasedConfig	openSystemConfig(Config parent, FS fs) Open the gitonfig configuration found in the system-wide "etc" directory
abstract FileBasedConfig	openUserConfig(Config parent, FS fs) Open the git configuration found in the user home
static void	setInstance(SystemReader newReader) Set the new instance to use when accessing properties.
protected void	setPlatformChecker() Should be used in tests when the platform is explicitly changed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

private static final SystemReader DEFAULT

isMacOS

private static java.lang.Boolean isMacOS

isWindows

private static java.lang.Boolean isWindows

INSTANCE

private static SystemReader INSTANCE

platformChecker

private ObjectChecker platformChecker

Constructor Detail

SystemReader

public SystemReader()

Method Detail

getInstance

public static SystemReader getInstance()

Get time since epoch, with up to millisecond resolution.

Returns:

time since epoch, with up to millisecond resolution.

setInstance

public static void setInstance(SystemReader newReader)

Set the new instance to use when accessing properties.

Parameters:

newReader - the new instance to use when accessing properties, or null for the default instance.

init

private void init()

setPlatformChecker

protected final void setPlatformChecker()

Should be used in tests when the platform is explicitly changed.

Since:

3.6

getHostname

public abstract java.lang.String getHostname()

Gets the hostname of the local host. If no hostname can be found, the hostname is set to the default value "localhost".

Returns:

the canonical hostname

getenv

public abstract java.lang.String getenv(java.lang.String variable)

Get value of the system variable

Parameters:

variable - system variable to read

Returns:

value of the system variable

getProperty

public abstract java.lang.String getProperty(java.lang.String key)

Get value of the system property

Parameters:

key - of the system property to read

Returns:

value of the system property

openUserConfig

public abstract FileBasedConfig openUserConfig(Config parent,
                                               FS fs)

Open the git configuration found in the user home

Parameters:

parent - a config with values not found directly in the returned config

fs - the file system abstraction which will be necessary to perform certain file system operations.

Returns:

the git configuration found in the user home

openSystemConfig

public abstract FileBasedConfig openSystemConfig(Config parent,
                                                 FS fs)

Open the gitonfig configuration found in the system-wide "etc" directory

Parameters:

parent - a config with values not found directly in the returned config. Null is a reasonable value here.

fs - the file system abstraction which will be necessary to perform certain file system operations.

Returns:

the gitonfig configuration found in the system-wide "etc" directory

getCurrentTime

public abstract long getCurrentTime()

Get the current system time

Returns:

the current system time

getClock

public MonotonicClock getClock()

Get clock instance preferred by this system.

Returns:

clock instance preferred by this system.

Since:

4.6

getTimezone

public abstract int getTimezone(long when)

Get the local time zone

Parameters:

when - a system timestamp

Returns:

the local time zone

getTimeZone

public java.util.TimeZone getTimeZone()

Get system time zone, possibly mocked for testing

Returns:

system time zone, possibly mocked for testing

Since:

1.2

getLocale

public java.util.Locale getLocale()

Get the locale to use

Returns:

the locale to use

Since:

1.2

getSimpleDateFormat

public java.text.SimpleDateFormat getSimpleDateFormat(java.lang.String pattern)

Returns a simple date format instance as specified by the given pattern.

Parameters:

pattern - the pattern as defined in SimpleDateFormat.SimpleDateFormat(String)

Returns:

the simple date format

Since:

2.0

getSimpleDateFormat

public java.text.SimpleDateFormat getSimpleDateFormat(java.lang.String pattern,
                                                      java.util.Locale locale)

Returns a simple date format instance as specified by the given pattern.

Parameters:

pattern - the pattern as defined in SimpleDateFormat.SimpleDateFormat(String)

locale - locale to be used for the SimpleDateFormat

Returns:

the simple date format

Since:

3.2

getDateTimeInstance

public java.text.DateFormat getDateTimeInstance(int dateStyle,
                                                int timeStyle)

Returns a date/time format instance for the given styles.

Parameters:

dateStyle - the date style as specified in DateFormat.getDateTimeInstance(int, int)

timeStyle - the time style as specified in DateFormat.getDateTimeInstance(int, int)

Returns:

the date format

Since:

2.0

isWindows

public boolean isWindows()

Whether we are running on Windows.

Returns:

true if we are running on Windows.

isMacOS

public boolean isMacOS()

Whether we are running on Mac OS X

Returns:

true if we are running on Mac OS X

getOsName

private java.lang.String getOsName()

checkPath

public void checkPath(java.lang.String path)
               throws CorruptObjectException

Check tree path entry for validity.

Scans a multi-directory path string such as "src/main.c".

Parameters:

path - path string to scan.

Throws:

CorruptObjectException - path is invalid.

Since:

3.6

checkPath

public void checkPath(byte[] path)
               throws CorruptObjectException

Check tree path entry for validity.

Scans a multi-directory path string such as "src/main.c".

Parameters:

path - path string to scan.

Throws:

CorruptObjectException - path is invalid.

Since:

4.2