Node (Atomix API Reference (2.1.0-beta1))

java.lang.Object
- io.atomix.cluster.Node

```
public class Node
extends Object
```
Represents a controller instance as a member in a cluster.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Node.Builder` Node builder.
`static class`	`Node.State` Represents the operational state of the instance.
`static class`	`Node.Type` Node type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Node.Builder`	`builder()` Returns a new node builder with no ID.
`static Node.Builder`	`builder(NodeId nodeId)` Returns a new node builder.
`static Node.Builder`	`builder(String nodeId)` Returns a new node builder.
`static Node`	`client(NodeId nodeId, io.atomix.messaging.Endpoint endpoint)` Returns a new client node.
`static Node`	`data(NodeId nodeId, io.atomix.messaging.Endpoint endpoint)` Returns a new data node.
`io.atomix.messaging.Endpoint`	`endpoint()` Returns the node endpoint.
`boolean`	`equals(Object object)`
`Node.State`	`getState()` Returns the node state.
`int`	`hashCode()`
`NodeId`	`id()` Returns the instance identifier.
`String`	`toString()`
`Node.Type`	`type()` Returns the node type.

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

- Method Detail
  - builder
```
public static Node.Builder builder()
```
    Returns a new node builder with no ID.
    
    Returns:
    
    the node builder
  - builder
```
public static Node.Builder builder(String nodeId)
```
    Returns a new node builder.
    
    Parameters:
    
    nodeId - the node identifier
    
    Returns:
    
    the node builder
    
    Throws:
    
    NullPointerException - if the node ID is null
  - builder
```
public static Node.Builder builder(NodeId nodeId)
```
    Returns a new node builder.
    
    Parameters:
    
    nodeId - the node identifier
    
    Returns:
    
    the node builder
    
    Throws:
    
    NullPointerException - if the node ID is null
  - data
```
public static Node data(NodeId nodeId,
                        io.atomix.messaging.Endpoint endpoint)
```
    Returns a new data node.
    
    Parameters:
    
    nodeId - the data node ID
    
    endpoint - the data node endpoint
    
    Returns:
    
    a new data node
  - client
```
public static Node client(NodeId nodeId,
                          io.atomix.messaging.Endpoint endpoint)
```
    Returns a new client node.
    
    Parameters:
    
    nodeId - the client node ID
    
    endpoint - the client node endpoint
    
    Returns:
    
    a new client node
  - id
```
public NodeId id()
```
    Returns the instance identifier.
    
    Returns:
    
    instance identifier
  - type
```
public Node.Type type()
```
    Returns the node type.
    
    Returns:
    
    the node type
  - endpoint
```
public io.atomix.messaging.Endpoint endpoint()
```
    Returns the node endpoint.
    
    Returns:
    
    the node endpoint
  - getState
```
public Node.State getState()
```
    Returns the node state.
    
    Returns:
    
    the node state
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Node

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

builder

builder

data

client

id

type

endpoint

getState

hashCode

equals

toString