org.cogroo.tools.checker.rules.model

Class Rule

java.lang.Object

org.cogroo.tools.checker.rules.model.Rule

All Implemented Interfaces:

Serializable

public class Rule
extends Object
implements Serializable

The error rule

Java class for Rule complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Rule">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Method">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}string">
               <enumeration value="general"/>
               <enumeration value="phrase-local"/>
               <enumeration value="subject-verb"/>
             </restriction>
           </simpleType>
         </element>
         <element name="Type" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="Group" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="Message" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="ShortMessage" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Pattern" type="{}Pattern"/>
         <element name="Boundaries" type="{}Boundaries"/>
         <element name="Suggestion" type="{}Suggestion" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Example" type="{}Example" maxOccurs="unbounded"/>
         <element name="ModificationHistory" type="{}ModificationHistory" maxOccurs="unbounded"/>
       </sequence>
       <attribute name="id" use="required" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="active" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="priority" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rule.Method Java class for null.

Constructor Summary

Constructors

Constructor and Description
Rule()

Method Summary

Modifier and Type	Method and Description
Boundaries	getBoundaries() Gets the value of the boundaries property.
List<Example>	getExample() Gets the value of the example property.
String	getGroup() Gets the value of the group property.
long	getId() Gets the value of the id property.
String	getMessage() Gets the value of the message property.
Rule.Method	getMethod() Gets the value of the method property.
List<ModificationHistory>	getModificationHistory() Gets the value of the modificationHistory property.
Pattern	getPattern() Gets the value of the pattern property.
Long	getPriority() Gets the value of the priority property.
String	getShortMessage() Gets the value of the shortMessage property.
List<Suggestion>	getSuggestion() Gets the value of the suggestion property.
String	getType() Gets the value of the type property.
boolean	isActive() Gets the value of the active property.
void	setActive(boolean value) Sets the value of the active property.
void	setBoundaries(Boundaries value) Sets the value of the boundaries property.
void	setGroup(String value) Sets the value of the group property.
void	setId(long value) Sets the value of the id property.
void	setMessage(String value) Sets the value of the message property.
void	setMethod(Rule.Method value) Sets the value of the method property.
void	setPattern(Pattern value) Sets the value of the pattern property.
void	setPriority(Long value) Sets the value of the priority property.
void	setShortMessage(String value) Sets the value of the shortMessage property.
void	setType(String value) Sets the value of the type property.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule()

Method Detail

getMethod

public Rule.Method getMethod()

Gets the value of the method property.

Returns:

possible object is Rule.Method

setMethod

public void setMethod(Rule.Method value)

Sets the value of the method property.

Parameters:

value - allowed object is Rule.Method

getType

public String getType()

Gets the value of the type property.

Returns:

possible object is String

setType

public void setType(String value)

Sets the value of the type property.

Parameters:

value - allowed object is String

getGroup

public String getGroup()

Gets the value of the group property.

Returns:

possible object is String

setGroup

public void setGroup(String value)

Sets the value of the group property.

Parameters:

value - allowed object is String

getMessage

public String getMessage()

Gets the value of the message property.

Returns:

possible object is String

setMessage

public void setMessage(String value)

Sets the value of the message property.

Parameters:

value - allowed object is String

getShortMessage

public String getShortMessage()

Gets the value of the shortMessage property.

Returns:

possible object is String

setShortMessage

public void setShortMessage(String value)

Sets the value of the shortMessage property.

Parameters:

value - allowed object is String

getPattern

public Pattern getPattern()

Gets the value of the pattern property.

Returns:

possible object is Pattern

setPattern

public void setPattern(Pattern value)

Sets the value of the pattern property.

Parameters:

value - allowed object is Pattern

getBoundaries

public Boundaries getBoundaries()

Gets the value of the boundaries property.

Returns:

possible object is Boundaries

setBoundaries

public void setBoundaries(Boundaries value)

Sets the value of the boundaries property.

Parameters:

value - allowed object is Boundaries

getSuggestion

public List<Suggestion> getSuggestion()

Gets the value of the suggestion property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the suggestion property.

For example, to add a new item, do as follows:

    getSuggestion().add(newItem);
 

Objects of the following type(s) are allowed in the list Suggestion

getExample

public List<Example> getExample()

Gets the value of the example property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the example property.

For example, to add a new item, do as follows:

    getExample().add(newItem);
 

Objects of the following type(s) are allowed in the list Example

getModificationHistory

public List<ModificationHistory> getModificationHistory()

Gets the value of the modificationHistory property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the modificationHistory property.

For example, to add a new item, do as follows:

    getModificationHistory().add(newItem);
 

Objects of the following type(s) are allowed in the list ModificationHistory

getId

public long getId()

Gets the value of the id property.

setId

public void setId(long value)

Sets the value of the id property.

isActive

public boolean isActive()

Gets the value of the active property.

setActive

public void setActive(boolean value)

Sets the value of the active property.

getPriority

public Long getPriority()

Gets the value of the priority property.

Returns:

possible object is Long

setPriority

public void setPriority(Long value)

Sets the value of the priority property.

Parameters:

value - allowed object is Long