Package com.microsoft.azure.servicebus.rules

Class RuleDescription

java.lang.Object

com.microsoft.azure.servicebus.rules.RuleDescription

public class RuleDescription
extends Object

Representation of a rule defined on service bus topics.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
RuleDescription()	Creates a rule description with no name, TrueFilter as filter and no action.
RuleDescription(Filter filter)	Creates a rule description with no name, given filter as filter and no action.
RuleDescription(String name)	Creates a rule description with the given name, TrueFilter as filter and no action.
RuleDescription(String name, Filter filter)	Creates a rule description with the given name, given filter as filter and no action.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
RuleAction	getAction()	Gets the action this rule performs on messages matched by this rule's filter.
Filter	getFilter()	Gets the filter of this rule.
String	getName()	Gets the name of this rule.
int	hashCode()
void	setAction(RuleAction action)	Sets the action this rule performs on messages matched by this rule's filter.
void	setFilter(Filter filter)	Sets the filter of this rule.
void	setName(String name)	Sets the name of this rule.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuleDescription

public RuleDescription()

Creates a rule description with no name, TrueFilter as filter and no action.

RuleDescription

public RuleDescription(String name)

Creates a rule description with the given name, TrueFilter as filter and no action.

Parameters:

name - name of the rule

RuleDescription

public RuleDescription(Filter filter)

Creates a rule description with no name, given filter as filter and no action.

Parameters:

filter - filter the rule uses to filter messages. Can be CorrelationFilter or SqlFilter.

RuleDescription

public RuleDescription(String name,
                       Filter filter)

Creates a rule description with the given name, given filter as filter and no action.

Parameters:

name - name of the rule

filter - filter this rule uses to filter messages. Can be Can be CorrelationFilter or SqlFilter.

Method Detail

getFilter

public Filter getFilter()

Gets the filter of this rule.

Returns:

the filter this rule uses to filter messages

setFilter

public void setFilter(Filter filter)

Sets the filter of this rule.

Parameters:

filter - filter this rule uses to filter messages. Can be Can be CorrelationFilter or SqlFilter.

getAction

public RuleAction getAction()

Gets the action this rule performs on messages matched by this rule's filter.

Returns:

action action this rule performs on matched messages

setAction

public void setAction(RuleAction action)

Sets the action this rule performs on messages matched by this rule's filter.

Parameters:

action - action this rule performs on matched messages

getName

public String getName()

Gets the name of this rule.

Returns:

name of this rule

setName

public void setName(String name)

Sets the name of this rule.

Parameters:

name - name of this rule

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object