Open Kilda Java Documentation
org.openkilda.messaging.model.rule.Rule Class Reference
Inheritance diagram for org.openkilda.messaging.model.rule.Rule:
org.openkilda.messaging.BaseMessage org.openkilda.messaging.model.rule.FlowDelete org.openkilda.messaging.model.rule.MeterDelete org.openkilda.messaging.model.rule.FlowInstall org.openkilda.messaging.model.rule.FlowUpdate org.openkilda.messaging.model.rule.MeterInstall org.openkilda.messaging.model.rule.MeterUpdate

Public Member Functions

 Rule ()
 
 Rule (@JsonProperty(RuleConstants.FLOW_ID) String flowId, @JsonProperty(RuleConstants.COOKIE) int cookie, @JsonProperty(RuleConstants.SWITCH_ID) String switchId)
 
String getFlowId ()
 
void setFlowId (String flowId)
 
String getSwitchId ()
 
void setSwitchId (String switchId)
 
int getCookie ()
 
void setCookie (int cookie)
 
boolean equals (Object object)
 
int hashCode ()
 
String toString ()
 
- Public Member Functions inherited from org.openkilda.messaging.BaseMessage
 BaseMessage (@JsonProperty(TIMESTAMP) final long timestamp)
 
 BaseMessage ()
 
long getTimestamp ()
 
void setTimestamp (long timestamp)
 

Protected Attributes

String flowId
 
int cookie
 
String switchId
 
- Protected Attributes inherited from org.openkilda.messaging.BaseMessage
long timestamp = 0L
 

Additional Inherited Members

- Static Public Member Functions inherited from org.openkilda.messaging.BaseMessage
static final< T extends BaseMessage > T getMessage (String json, Class< T > type) throws java.io.IOException
 
static final< T extends BaseMessage > T tryGetMessage (String json, Class< T > type)
 

Detailed Description

Represents base rule entity.

Definition at line 33 of file Rule.java.

Constructor & Destructor Documentation

◆ Rule() [1/2]

org.openkilda.messaging.model.rule.Rule.Rule ( )

Default constructor.

Definition at line 60 of file Rule.java.

◆ Rule() [2/2]

org.openkilda.messaging.model.rule.Rule.Rule ( @JsonProperty(RuleConstants.FLOW_ID) String  flowId,
@JsonProperty(RuleConstants.COOKIE) int  cookie,
@JsonProperty(RuleConstants.SWITCH_ID) String  switchId 
)

Instance constructor.

Parameters
flowIdrule flow id
switchIdrule switch id
cookierule cookie

Definition at line 71 of file Rule.java.

Member Function Documentation

◆ equals()

boolean org.openkilda.messaging.model.rule.Rule.equals ( Object  object)

Definition at line 138 of file Rule.java.

◆ getCookie()

int org.openkilda.messaging.model.rule.Rule.getCookie ( )

Gets cookie.

Returns
cookie

Definition at line 121 of file Rule.java.

◆ getFlowId()

String org.openkilda.messaging.model.rule.Rule.getFlowId ( )

Gets flow id.

Returns
flow id

Definition at line 85 of file Rule.java.

◆ getSwitchId()

String org.openkilda.messaging.model.rule.Rule.getSwitchId ( )

Gets switch id.

Returns
switch id

Definition at line 103 of file Rule.java.

◆ hashCode()

int org.openkilda.messaging.model.rule.Rule.hashCode ( )

Definition at line 157 of file Rule.java.

◆ setCookie()

void org.openkilda.messaging.model.rule.Rule.setCookie ( int  cookie)

Sets cooke.

Parameters
cookiecookie

Definition at line 130 of file Rule.java.

◆ setFlowId()

void org.openkilda.messaging.model.rule.Rule.setFlowId ( String  flowId)

Sets flow id.

Parameters
flowIdflow id

Definition at line 94 of file Rule.java.

◆ setSwitchId()

void org.openkilda.messaging.model.rule.Rule.setSwitchId ( String  switchId)

Sets switch id.

Parameters
switchIdswitch id

Definition at line 112 of file Rule.java.

◆ toString()

String org.openkilda.messaging.model.rule.Rule.toString ( )

Definition at line 165 of file Rule.java.

Member Data Documentation

◆ cookie

int org.openkilda.messaging.model.rule.Rule.cookie
protected

Flow cookie.

Definition at line 49 of file Rule.java.

◆ flowId

String org.openkilda.messaging.model.rule.Rule.flowId
protected

Flow id.

Definition at line 43 of file Rule.java.

◆ switchId

String org.openkilda.messaging.model.rule.Rule.switchId
protected

Rule switch id.

Definition at line 55 of file Rule.java.


The documentation for this class was generated from the following file: