jenkins.scm.api

Class SCMProbeStat

java.lang.Object

jenkins.scm.api.SCMProbeStat

public class SCMProbeStat
extends Object

Represents the result of an existence check which may optionally include details of an alternative name for the object being checked for existence.

Since:

2.0

See Also:

SCMProbe.stat(String)

Method Summary

Modifier and Type	Method and Description
boolean	exists() Shorthand for getType()!= SCMFile.Type.NONEXISTENT.
static SCMProbeStat	fromAlternativePath(String alternativePath) Creates a SCMProbeStat from an alternative path suggestion.
static SCMProbeStat	fromType(SCMFile.Type type) Creates a SCMProbeStat from a SCMFile.Type.
String	getAlternativePath() If getType()!= SCMFile.Type.NONEXISTENT and there is an alternative name that would match but for case sensitivity or a typo.
SCMFile.Type	getType() The type of entity or SCMFile.Type.NONEXISTENT if the entity does not exist.

Methods inherited from class java.lang.Object

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

Method Detail

fromType

public static SCMProbeStat fromType(@NonNull
                                    SCMFile.Type type)

Creates a SCMProbeStat from a SCMFile.Type.

Parameters:

type - the SCMFile.Type.

Returns:

the SCMProbeStat.

fromAlternativePath

public static SCMProbeStat fromAlternativePath(@NonNull
                                               String alternativePath)

Creates a SCMProbeStat from an alternative path suggestion.

Parameters:

alternativePath - the suggested alternative path.

Returns:

the SCMProbeStat.

exists

public boolean exists()

Shorthand for getType()!= SCMFile.Type.NONEXISTENT.

Returns:

getType()!= SCMFile.Type.NONEXISTENT.

getAlternativePath

@CheckForNull
public String getAlternativePath()

If getType()!= SCMFile.Type.NONEXISTENT and there is an alternative name that would match but for case sensitivity or a typo.

Returns:

a suggested alternative name.

getType

@NonNull
public SCMFile.Type getType()

The type of entity or SCMFile.Type.NONEXISTENT if the entity does not exist.

Returns:

the type of entity.