com.github.writethemfirst.approvals.reporters

Enum SupportedOs

java.lang.Object

java.lang.Enum<SupportedOs>

com.github.writethemfirst.approvals.reporters.SupportedOs

All Implemented Interfaces:

Serializable, Comparable<SupportedOs>

public enum SupportedOs
extends Enum<SupportedOs>

SupportedOs

Approvals-Java can be executed from all kind of environments, which also means all kind of OS (at least Windows, Linux, Mac OSX).

That means some operations will have to be handled in different ways depending on which Operating System it is executed on.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LINUX
MACOS
WINDOWS

Field Summary

Fields

Modifier and Type	Field and Description
boolean	active

Method Summary

Modifier and Type	Method and Description
static Optional<Reporter>	osDefaultReporter() Identifies the current OS and the associated Reporter.
static SupportedOs	valueOf(String name) Returns the enum constant of this type with the specified name.
static SupportedOs[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WINDOWS

public static final SupportedOs WINDOWS

MACOS

public static final SupportedOs MACOS

LINUX

public static final SupportedOs LINUX

Field Detail

active

public final boolean active

Method Detail

values

public static SupportedOs[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SupportedOs c : SupportedOs.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SupportedOs valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

osDefaultReporter

public static Optional<Reporter> osDefaultReporter()

Identifies the current OS and the associated Reporter.

Returns:

the default Reporter (which will run a native diff tool) for the OS