ch.epfl.dedis.lib.darc

Class Rules

java.lang.Object

ch.epfl.dedis.lib.darc.Rules

public class Rules
extends Object

Rules is a list of action-expression associations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AND
static String	OR

Constructor Summary

Constructors

Constructor and Description
Rules() Default constructor that creates an empty rule list.
Rules(DarcProto.Rules rules) Constructor for the protobuf representation.
Rules(Rules other) This is the copy constructor.

Method Summary

Modifier and Type	Method and Description
void	addRule(String a, byte[] expr) Adds a rule.
boolean	contains(String a) Checks whether a rule exists.
Rule	get(String a) Gets a rule, if it does not exist then null is returned.
List<String>	getAllActions() Gets all the actions as a List.
List<Rule>	getAllRules() Gets all rules as a List.
Rule	remove(String a) Removes the action if it exists.
DarcProto.Rules	toProto() Converts the rule to its protobuf representation.
void	updateRule(String a, byte[] expr) Updates a rule.

Methods inherited from class java.lang.Object

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

Field Detail

OR

public static final String OR

See Also:

Constant Field Values

AND

public static final String AND

See Also:

Constant Field Values

Constructor Detail

Rules

public Rules()

Default constructor that creates an empty rule list.

Rules

public Rules(Rules other)

This is the copy constructor.

Parameters:

other -

Rules

public Rules(DarcProto.Rules rules)

Constructor for the protobuf representation.

Parameters:

rules -

Method Detail

addRule

public void addRule(String a,
                    byte[] expr)
             throws CothorityAlreadyExistsException

Adds a rule. CothorityAlreadyExistsException is thrown if the action that the function is trying to add already exists.

Parameters:

a - is the action

expr - is the expression

Throws:

CothorityAlreadyExistsException

updateRule

public void updateRule(String a,
                       byte[] expr)
                throws CothorityNotFoundException

Updates a rule. CothorityNotFoundException is thrown if the action that we are trying to update does not exist.

Parameters:

a - is the action

expr - is the expression

Throws:

CothorityNotFoundException

get

public Rule get(String a)

Gets a rule, if it does not exist then null is returned.

Parameters:

a - is the action

Returns:

getAllRules

public List<Rule> getAllRules()

Gets all rules as a List.

Returns:

getAllActions

public List<String> getAllActions()

Gets all the actions as a List.

Returns:

remove

public Rule remove(String a)

Removes the action if it exists.

Parameters:

a - is the action

Returns:

the removed Rule if it exists, otherwise null.

contains

public boolean contains(String a)

Checks whether a rule exists.

Parameters:

a - is the action

Returns:

toProto

public DarcProto.Rules toProto()

Converts the rule to its protobuf representation.

Returns:

the protobuf representation