CredentialValidationResult (ph-security 11.0.6 API)

java.lang.Object
- com.helger.security.authentication.credentials.CredentialValidationResult

All Implemented Interfaces:

com.helger.commons.state.ISuccessIndicator, com.helger.commons.text.display.IHasDisplayText, ICredentialValidationResult
```
public class CredentialValidationResult
extends Object
implements ICredentialValidationResult
```
Default implementation of ICredentialValidationResult.

Author:

Philip Helger

Field Summary

Fields
Modifier and Type Field Description

static CredentialValidationResult SUCCESS

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`CredentialValidationResult()`	Success only constructor.
	`CredentialValidationResult(String sErrorMsg)`	Constructor with an error message

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDisplayText(Locale aDisplayLocale)`
`String`	`getErrorMessage()`
`boolean`	`isFailure()`
`boolean`	`isSuccess()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.text.display.IHasDisplayText
getAsHasText

Methods inherited from interface com.helger.commons.state.ISuccessIndicator
and, or

- Field Detail
  - SUCCESS
```
public static final CredentialValidationResult SUCCESS
```
- Constructor Detail
  - CredentialValidationResult
```
protected CredentialValidationResult()
```
    Success only constructor.
  - CredentialValidationResult
```
public CredentialValidationResult(@Nonnull @Nonempty
                                  String sErrorMsg)
```
    Constructor with an error message
    
    Parameters:
    
    sErrorMsg - The error message. May neither be null nor empty.
- Method Detail
  - getErrorMessage
```
@Nonnull
@Nonempty
public final String getErrorMessage()
```
  - isSuccess
```
public boolean isSuccess()
```
    Specified by:
    
    isSuccess in interface com.helger.commons.state.ISuccessIndicator
  - isFailure
```
public boolean isFailure()
```
    Specified by:
    
    isFailure in interface com.helger.commons.state.ISuccessIndicator
  - getDisplayText
```
@Nullable
public String getDisplayText(@Nonnull
                             Locale aDisplayLocale)
```
    Specified by:
    
    getDisplayText in interface com.helger.commons.text.display.IHasDisplayText
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object