McastRole (segmentrouting-impl 3.1.0 API)

java.lang.Object
- java.lang.Enum<McastRole>
- - org.onosproject.segmentrouting.mcast.McastRole

All Implemented Interfaces:

Serializable, Comparable<McastRole>
```
public enum McastRole
extends Enum<McastRole>
```
Enum that defines role in the multicast tree.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`EGRESS`	The device is the egress device of this group.
`INGRESS`	The device is the ingress device of this group.
`TRANSIT`	The device is the transit device of this group.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static McastRole`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static McastRole[]`	`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
  - INGRESS
```
public static final McastRole INGRESS
```
    The device is the ingress device of this group.
  - TRANSIT
```
public static final McastRole TRANSIT
```
    The device is the transit device of this group.
  - EGRESS
```
public static final McastRole EGRESS
```
    The device is the egress device of this group.
- Method Detail
  - values
```
public static McastRole[] 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 (McastRole c : McastRole.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static McastRole 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