de.aristaflow.adept2.model.orgmodel

Class OrgPolicyReport

java.lang.Object

de.aristaflow.adept2.model.orgmodel.OrgPolicyReport

All Implemented Interfaces:

java.io.Serializable

public class OrgPolicyReport
extends java.lang.Object
implements java.io.Serializable

An instance of OrgPolicyReport is used to store entries for problems and other issues encountered while parsing an OrgPolicy.

Author:

Patrick Schmidt

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrgPolicyReport.Entry 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.
static class	OrgPolicyReport.Range Represents a range within an OrgPolicy.
static class	OrgPolicyReport.ResultType The ResultType is used for the overall result

Constructor Summary

Constructors

Constructor and Description
OrgPolicyReport()

Method Summary

Modifier and Type	Method and Description
void	addEntry(OrgPolicyReport.Entry entry) Adds the given entry to this report's list of entries.
void	addEntry(OrgPolicyReport.ResultType resultType, java.lang.String description, int beginColumn, int endColumn) Creates an entry for the given values and adds it to this report's list of entries.
void	addEntry(OrgPolicyReport.ResultType resultType, java.lang.String description, OrgPolicyReport.Range... ranges) Creates an entry for the given values and adds it to this report's list of entries.
OrgPolicyReport.Entry[]	getEntries() Returns an array containing all entries of this report.
OrgPolicyReport.Entry	getEntryAt(int index) Returns the entry at the given index.
int	getEntryCount() Returns the current number of entries in this report.
OrgPolicyReport.ResultType	getOverallResult() Returns the overall result type of this report.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrgPolicyReport

public OrgPolicyReport()

Method Detail

getOverallResult

public OrgPolicyReport.ResultType getOverallResult()

Returns the overall result type of this report. This is determined by the "worst" result type across all its entries.

Returns:

the overall result type of this report

getEntryCount

public int getEntryCount()

Returns the current number of entries in this report.

Returns:

the current number of entries in this report

getEntryAt

public OrgPolicyReport.Entry getEntryAt(int index)

Returns the entry at the given index.

Parameters:

index - the index of the entry to be returned

Returns:

the entry at the given index

getEntries

public OrgPolicyReport.Entry[] getEntries()

Returns an array containing all entries of this report.

Returns:

an array containing all entries of this report

addEntry

public void addEntry(OrgPolicyReport.Entry entry)

Adds the given entry to this report's list of entries.

Parameters:

entry - the entry to be added to this report's list of entries

addEntry

public void addEntry(OrgPolicyReport.ResultType resultType,
                     java.lang.String description,
                     int beginColumn,
                     int endColumn)

Creates an entry for the given values and adds it to this report's list of entries.

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

addEntry

public void addEntry(OrgPolicyReport.ResultType resultType,
                     java.lang.String description,
                     OrgPolicyReport.Range... ranges)

Creates an entry for the given values and adds it to this report's list of entries.

Parameters:

resultType - the result type of the new entry

description - the description of the new entry

ranges - the affected ranges