Publish.Retain (JMRI API)

java.lang.Object
- java.lang.Enum<Publish.Retain>
- - jmri.jmrix.mqtt.logixng.Publish.Retain

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Publish.Retain>

Enclosing class:

Publish
```
public static enum Publish.Retain
extends java.lang.Enum<Publish.Retain>
```

Enum Constant Summary

Enum Constants
Enum Constant Description

Default

No

Yes

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`getRetainValue(MqttSystemConnectionMemo memo)`
`java.lang.String`	`toString()`
`static Publish.Retain`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static Publish.Retain[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - Default
```
public static final Publish.Retain Default
```
  - Yes
```
public static final Publish.Retain Yes
```
  - No
```
public static final Publish.Retain No
```
- Method Detail
  - values
```
public static Publish.Retain[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (Publish.Retain c : Publish.Retain.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Publish.Retain valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getRetainValue
```
public boolean getRetainValue(MqttSystemConnectionMemo memo)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<Publish.Retain>