com.github.cmake.maven.project.common

Class Platform

java.lang.Object

com.github.cmake.maven.project.common.Platform

public final class Platform
extends Object

A combination of a system's architecture and operating system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Platform.Architecture The architecture of an operating system.
static class	Platform.OperatingSystem Operating systems.

Field Summary

Fields

Modifier and Type	Field and Description
Platform.Architecture	architecture The architecture of the platform.
Platform.OperatingSystem	operatingSystem The operating system of the platform.

Method Summary

Modifier and Type	Method and Description
boolean	canRunTests()
static Platform	detected() Returns the detected platform.
String	getClassifier() Returns the classifier associated with this platform.
String	getDownloadSuffix() Returns the suffix to append to the cmake download filename.
String	getEnvironment(ProcessBuilder processBuilder, String name) Returns the value of a ProcessBuilder's environment variable.
Path	getExecutableOnPath(String filename, String path) Returns the fully qualified path of the executable.
String	getExecutableSuffix() Returns the suffix to append to the cmake executables.
boolean	isDownloadAvailable()
void	overrideEnvironmentVariables(Map<String,String> source, ProcessBuilder target) Overrides the environment variables of a process builder.
boolean	shipsWithPlatform()
boolean	supportsPosix(InputStream in) Indicates if the operating system supports POSIX attributes.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

operatingSystem

public final Platform.OperatingSystem operatingSystem

The operating system of the platform.

architecture

public final Platform.Architecture architecture

The architecture of the platform.

Method Detail

detected

public static Platform detected()

Returns the detected platform.

Returns:

the detected platform

shipsWithPlatform

public boolean shipsWithPlatform()

Returns:

true if cmake binaries ship with the platform

isDownloadAvailable

public boolean isDownloadAvailable()

Returns:

true if the platform binaries are available on CMake's website

canRunTests

public boolean canRunTests()

Returns:

true if automated tests can run on this platform

getClassifier

public String getClassifier()

Returns the classifier associated with this platform.

Returns:

the classifier associated with this platform

Throws:

UnsupportedOperationException - if CMake's website does not provide binaries for this platform

getExecutableOnPath

public Path getExecutableOnPath(String filename,
                                String path)
                         throws FileNotFoundException

Returns the fully qualified path of the executable.

Parameters:

filename - the filename of a binary

path - the PATH environment variable

Returns:

the fully qualified path of the executable

Throws:

NullPointerException - if any of the arguments are null

FileNotFoundException - if the binary could not be found

getExecutableSuffix

public String getExecutableSuffix()

Returns the suffix to append to the cmake executables.

Returns:

the suffix to append to the cmake executables

Throws:

UnsupportedOperationException - if CMake's website does not provide binaries for this platform

getDownloadSuffix

public String getDownloadSuffix()

Returns the suffix to append to the cmake download filename.

Returns:

the suffix to append to the cmake download filename

Throws:

UnsupportedOperationException - if CMake's website does not provide binaries for this platform

supportsPosix

public boolean supportsPosix(InputStream in)

Indicates if the operating system supports POSIX attributes.

Parameters:

in - the InputStream associated with the archive

Returns:

true if the operating system supports POSIX attributes

Throws:

UnsupportedOperationException - if CMake's website does not provide binaries for this platform

getEnvironment

public String getEnvironment(ProcessBuilder processBuilder,
                             String name)

Returns the value of a ProcessBuilder's environment variable.

Parameters:

processBuilder - a ProcessBuilder

name - an environment variable

Returns:

the value of the environment variable

overrideEnvironmentVariables

public void overrideEnvironmentVariables(Map<String,String> source,
                                         ProcessBuilder target)

Overrides the environment variables of a process builder.

Parameters:

source - new environment variables

target - existing environment variables

Throws:

NullPointerException - if any of the arguments are null

toString

public String toString()

Overrides:

toString in class Object