Package de.aristaflow.adept2.model.orgmodel

Class OrgPolicyReport.Entry

java.lang.Object

de.aristaflow.adept2.model.orgmodel.OrgPolicyReport.Entry

All Implemented Interfaces:

Serializable

Enclosing class:

OrgPolicyReport

public static class OrgPolicyReport.Entry
extends Object
implements Serializable

An OrgPolicyReport.Entry is what the name implies: an entry in a OrgPolicyReport and contains data about one error, warning or other information about the parsed OrgPolicy.

More specifically, it contains a result type, a human readable description and zero or more OrgPolicyReport.Ranges that tell which sections of OrgPolicy this entry refers to. The latter could be used e.g. in graphical support tools to mark concerned segments of the OrgPolicy with wavy red underlines.

Please note, that the column indexes start at 0! So the first column has index 0, the second 1 etc.. Also note that a range is the half-open interval [begin,end). This is in accordance with String.substring(int, int).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Entry(OrgPolicyReport.ResultType resultType, String description, int beginColumn, int endColumn)	Constructs an entry for the given values.
Entry(OrgPolicyReport.ResultType resultType, String description, OrgPolicyReport.Range... ranges)	Creates an entry for the given values.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of this entry.
OrgPolicyReport.Range[]	getRanges()	Returns the policy ranges this entry relates to.
OrgPolicyReport.ResultType	getResultType()	Returns the (result) type of this entry.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Entry

public Entry(OrgPolicyReport.ResultType resultType,
             String description,
             int beginColumn,
             int endColumn)

Constructs an entry for the given values.

Parameters:

resultType - the result type of the new entry

description - the description of the new entry

beginColumn - the begin column of the affected range

endColumn - the end column of the affected range

Entry

public Entry(OrgPolicyReport.ResultType resultType,
             String description,
             OrgPolicyReport.Range... ranges)

Creates an entry for the given values.

Parameters:

resultType - the result type of the new entry

description - the description of the new entry

ranges - the affected ranges

Method Detail

getResultType

public OrgPolicyReport.ResultType getResultType()

Returns the (result) type of this entry.

Returns:

the (result) type of this entry

getDescription

public String getDescription()

Returns the description of this entry.

Returns:

the description of this entry

getRanges

public OrgPolicyReport.Range[] getRanges()

Returns the policy ranges this entry relates to. The array may be empty but it's never null.

Returns:

the policy ranges this entry relates to

toString

public String toString()

Overrides:

toString in class Object