Role (Apache Geode 2.0.2)
Description: declaration: package: org.apache.geode.distributed, interface: Role

Package org.apache.geode.distributed

# Interface Role

All Superinterfaces:
  `Comparable<Role>`

@Deprecated public interface Role extends Comparable<Role>
Deprecated.
this feature is scheduled to be removed
Members of the distributed system can fill one or more user defined roles. A role is metadata that describes how the member relates to other members or what purpose it fills. Roles are specified when connecting to the `DistributedSystem`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getCount()`
  Deprecated.
  Returns the count of members currently filling this role.
  `String`
  `getName()`
  Deprecated.
  Returns the name of this role.
  `boolean`
  `isPresent()`
  Deprecated.
  Returns true if this role is currently present in distributed system.

  ### Methods inherited from interface java.lang.Comparable

  `compareTo`

- ## Method Details

  - ### getName

    String getName()
    Deprecated.
    Returns the name of this role.
    Returns:
      user-defined string name of this role

  - ### isPresent

    boolean isPresent()
    Deprecated.
    Returns true if this role is currently present in distributed system. If true, then at least one member in the system is configured with this role, regardless of whether or not that member has a cache.
    Returns:
      true if this role is currently present in distributed system

  - ### getCount

    int getCount()
    Deprecated.
    Returns the count of members currently filling this role. These members may or may not have a cache.
    Returns:
      number of members in system currently filling this role