com.perforce.halm.jenkins.globalconfig

Class HALMConnection.AbstractResult

java.lang.Object

com.perforce.halm.jenkins.globalconfig.HALMConnection.AbstractResult

Direct Known Subclasses:

HALMConnection.AuthInfoResult, HALMConnection.ConnectionInfoResult, HALMConnection.CredentialDetailsResult

Enclosing class:

HALMConnection

public abstract static class HALMConnection.AbstractResult
extends Object

Abstract base class for results, provides common error handling.

Field Summary

Fields

Modifier and Type	Field and Description
String	error If an error occurs while parsing the authorization info, this will be set to a message indicating what the problem was.

Constructor Summary

Constructors

Constructor and Description
AbstractResult()

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage() Any relevant error message.
boolean	isError() Checks if the result indicates an error occurred.
protected boolean	isErrorInternal() Implementer can extend isError safely by implementing isErrorInternal.

Methods inherited from class java.lang.Object

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

Field Detail

error

public String error

If an error occurs while parsing the authorization info, this will be set to a message indicating what the problem was.

Constructor Detail

AbstractResult

public AbstractResult()

Method Detail

isError

public final boolean isError()

Checks if the result indicates an error occurred. Check getErrorMessage() for an error message.

Returns:

True if there was an error,

getErrorMessage

public String getErrorMessage()

Any relevant error message. If no error message exists, a default one is returned.

Returns:

Any relevant error message. If no error message exists, a default one is returned.

isErrorInternal

protected boolean isErrorInternal()

Implementer can extend isError safely by implementing isErrorInternal.

Returns:

True indicates the implementor thinks this result should be a failure.