com.synopsys.arc.jenkinsci.plugins.customtools

Class PathsList

java.lang.Object

com.synopsys.arc.jenkinsci.plugins.customtools.PathsList

All Implemented Interfaces:

Serializable

public class PathsList
extends Object
implements Serializable

Structure with list

Author:

Oleg Nenashev , Synopsys Inc.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PathsList	EMPTY
String	homeDir
List<String>	paths
String	pathSeparator
String	separator

Constructor Summary

Constructors

Constructor and Description
PathsList() Empty constructor.
PathsList(Collection<String> paths, String homeDir) Constructor.
PathsList(Collection<String> paths, String pathSeparator, String separator, String homeDir)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(PathsList pathsList) Adds PathsList and overrides null variables.
boolean	add(String path)
String	getHomeDir()
String	toListString() Gets the list of installed tools.

Methods inherited from class java.lang.Object

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

Field Detail

paths

@Nonnull
public List<String> paths

homeDir

@CheckForNull
public String homeDir

pathSeparator

@CheckForNull
public String pathSeparator

separator

@CheckForNull
public String separator

EMPTY

public static final PathsList EMPTY

Constructor Detail

PathsList

public PathsList(@Nonnull
         Collection<String> paths,
         @CheckForNull
         String homeDir)

Constructor. Sets system's default separator and pathSeparator

Parameters:

paths - List of paths to be returned

homeDir - Home directory of the tool

PathsList

public PathsList()

Empty constructor. doesn't set pathSeparator and separator

PathsList

public PathsList(@Nonnull
         Collection<String> paths,
         @CheckForNull
         String pathSeparator,
         @CheckForNull
         String separator,
         @CheckForNull
         String homeDir)

Method Detail

getHomeDir

@CheckForNull
public String getHomeDir()

add

public boolean add(@Nonnull
          String path)

add

public boolean add(@Nonnull
          PathsList pathsList)

Adds PathsList and overrides null variables.

Parameters:

pathsList - PathsList to be added

Returns:

True if the paths list has been modified after the tool installation

toListString

@CheckForNull
public String toListString()

Gets the list of installed tools.

Returns:

A list with valid delimiters or null if paths is empty