CheckHost (OpenEMS Javadoc)

java.lang.Object
- io.openems.edge.core.appmanager.validator.AbstractCheckable
- - io.openems.edge.core.appmanager.validator.CheckHost

All Implemented Interfaces:: Checkable

public class CheckHost
extends AbstractCheckable
implements Checkable

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String COMPONENT_NAME

Constructor Summary

Constructors
Constructor Description

CheckHost(org.osgi.service.component.ComponentContext componentContext)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`check()`	Checks if the implemented task was successful or not.
`java.lang.String`	`getErrorMessage(Language language)`	Gets the error message if the check was incorrect completed.
`void`	`setProperties(java.util.Map<java.lang.String,?> properties)`	Sets the properties.

Methods inherited from class io.openems.edge.core.appmanager.validator.AbstractCheckable
getComponentName, getTranslation

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

Methods inherited from interface io.openems.edge.core.appmanager.validator.Checkable
getComponentName

- Field Detail
  - COMPONENT_NAME
```
public static final java.lang.String COMPONENT_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CheckHost
```
public CheckHost(org.osgi.service.component.ComponentContext componentContext)
```
- Method Detail
  - setProperties
```
public void setProperties(java.util.Map<java.lang.String,?> properties)
```
    Description copied from interface: Checkable
    
    Sets the properties.
    
    Specified by:
    
    setProperties in interface Checkable
    
    Parameters:
    
    properties - the properties to be set for the next check
  - check
```
public boolean check()
```
    Description copied from interface: Checkable
    
    Checks if the implemented task was successful or not.
    
    Specified by:
    
    check in interface Checkable
    
    Returns:
    
    true if the check was successful else false
  - getErrorMessage
```
public java.lang.String getErrorMessage(Language language)
```
    Description copied from interface: Checkable
    
    Gets the error message if the check was incorrect completed.
    
    Specified by:
    
    getErrorMessage in interface Checkable
    
    Parameters:
    
    language - the language of the message
    
    Returns:
    
    the message