RelType (JSONAPI Converter 0.13 API)

java.lang.Object
- java.lang.Enum<RelType>
- - com.github.jasminb.jsonapi.RelType

All Implemented Interfaces:

Serializable, Comparable<RelType>
```
public enum RelType
extends Enum<RelType>
```
Encapsulates supported relationship types.

Enum Constant Summary

Enum Constants
Enum Constant Description

RELATED

SELF

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getRelName()`	Obtains the name of the relationship, suitable for use in serialized JSON.
`static RelType`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static RelType[]`	`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, toString, valueOf

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

- Enum Constant Detail
  - SELF
```
public static final RelType SELF
```
  - RELATED
```
public static final RelType RELATED
```
- Method Detail
  - values
```
public static RelType[] 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 (RelType c : RelType.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RelType valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getRelName
```
public String getRelName()
```
    Obtains the name of the relationship, suitable for use in serialized JSON.
    
    Returns:
    
    the relationship name