Report (Static Analysis Model and Parsers 1.0.0-RC21 API)

java.lang.Object
- edu.hm.hafner.analysis.Report

All Implemented Interfaces:

Serializable, Iterable<Issue>
```
public class Report
extends Object
implements Iterable<Issue>, Serializable
```
A report contains a set of unique issues: it contains no duplicate elements, i.e. it models the mathematical set abstraction. This report provides a total ordering on its elements. I.e., the issues in this report are ordered by their index: the first added issue is at position 0, the second added issues is at position 1, and so on.
Additionally, this report provides methods to find and filter issues based on different properties. In order to create issues use the provided builder class.

Author:

Ullrich Hafner

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Report.IssueFilterBuilder
Builds a combined filter based on several include and exclude filters.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Report.IssueFilterBuilder` Builds a combined filter based on several include and exclude filters.

Constructor Summary

Constructors
Constructor and Description
`Report()` Creates an empty `Report`.
`Report(Collection<Report> reports)` Creates a new `Report` that is an aggregation of the specified `reports`.
`Report(Report... reports)` Creates a new `Report` that is an aggregation of the specified `reports`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Report`	`add(Issue issue)` Appends the specified issue to the end of this report.
`Report`	`addAll(Collection<? extends Issue> issues)` Appends all of the specified issues to the end of this report, preserving the order of the array elements.
`Report`	`addAll(Issue issue, Issue... additionalIssues)` Appends all of the specified issues to the end of this report, preserving the order of the array elements.
`Report`	`addAll(Report... reports)` Appends the specified `reports` to this report.
`Report`	`copy()` Returns a shallow copy of this issue container.
`Report`	`copyEmptyInstance()` Returns a new empty issue container with the same properties as this container.
`boolean`	`equals(Object o)`
`Report`	`filter(Predicate<? super Issue> criterion)` Finds all issues that match the specified criterion.
`Issue`	`findById(UUID issueId)` Returns the issue with the specified ID.
`Set<Issue>`	`findByProperty(Predicate<? super Issue> criterion)` Finds all issues that match the specified criterion.
`Issue`	`get(int index)` Returns the issue with the specified index.
`Set<String>`	`getCategories()` Returns the used categories for all issues.
`int`	`getDuplicatesSize()` Returns the number of duplicates.
`org.eclipse.collections.api.list.ImmutableList<String>`	`getErrorMessages()` Returns the error messages that have been reported since the creation of this set of issues.
`Set<String>`	`getFiles()` Returns the affected files for all issues.
`org.eclipse.collections.api.list.ImmutableList<String>`	`getInfoMessages()` Returns the info messages that have been reported since the creation of this set of issues.
`Set<String>`	`getModules()` Returns the affected modules for all issues.
`Set<String>`	`getPackages()` Returns the affected packages for all issues.
`<T> Set<T>`	`getProperties(Function<? super Issue,T> propertiesMapper)` Returns the different values for a given property for all issues.
`<T> Map<T,Integer>`	`getPropertyCount(Function<? super Issue,T> propertiesMapper)` Returns the number of occurrences for every existing value of a given property for all issues.
`Set<Severity>`	`getSeverities()` Returns the severities of all issues.
`int`	`getSize()` Returns the number of issues in this report.
`int`	`getSizeOf(Severity severity)` Returns the number of issues with the specified `Severity`.
`int`	`getSizeOf(String severity)` Returns the number of issues with the specified `severity`.
`Set<String>`	`getTools()` Returns the names of the tools that did report the issues.
`Set<String>`	`getTypes()` Returns the used types for all issues.
`Map<String,Report>`	`groupByProperty(String propertyName)` Groups issues by a specified property.
`boolean`	`hasCategories()` Returns whether this report contains issues with different categories.
`boolean`	`hasErrors()` Returns whether error messages have been reported.
`boolean`	`hasFiles()` Returns whether this report contains more than one affected file.
`int`	`hashCode()`
`boolean`	`hasModules()` Returns whether this report contains affected files from more than one module.
`boolean`	`hasPackages()` Returns whether this report contains affected files from more than one package.
`boolean`	`hasSeverities()` Returns whether this report contains issues of different severities.
`boolean`	`hasTools()` Returns whether this report contains issues created by different tools.
`boolean`	`hasTypes()` Returns whether this report contains issues with different types.
`boolean`	`isEmpty()` Returns whether this report is empty.
`boolean`	`isNotEmpty()` Returns whether this report is not empty.
`Iterator<Issue>`	`iterator()`
`void`	`logError(String format, Object... args)` Logs the specified error message.
`void`	`logException(Exception exception, String format, Object... args)` Logs the specified exception.
`void`	`logInfo(String format, Object... args)` Logs the specified information message.
`Issue`	`remove(UUID issueId)` Removes the issue with the specified ID.
`int`	`size()` Returns the number of issues in this container.
`Stream<Issue>`	`stream()` Creates a new sequential `Stream` of `Issue` instances from a `Spliterator`.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Report
```
public Report()
```
    Creates an empty Report.
  - Report
```
public Report(Report... reports)
```
    Creates a new Report that is an aggregation of the specified reports. The created report will contain the issues of all specified reports, in the same order. The properties of the specified reports will also be copied.
    
    Parameters:
    
    reports - the reports to append
    
    See Also:
    
    copyIssuesAndProperties(Report, Report)
  - Report
```
public Report(Collection<Report> reports)
```
    Creates a new Report that is an aggregation of the specified reports. The created report will contain the issues of all specified reports, in the same order. The properties of the specified reports will also be copied.
    
    Parameters:
    
    reports - the initial set of issues
    
    See Also:
    
    copyIssuesAndProperties(Report, Report)
- Method Detail
  - add
```
public Report add(Issue issue)
```
    Appends the specified issue to the end of this report. Duplicates will be skipped (the number of skipped elements is available using the method getDuplicatesSize().
    
    Parameters:
    
    issue - the issue to append
    
    Returns:
    
    this
  - addAll
```
public Report addAll(Issue issue,
                     Issue... additionalIssues)
```
    Appends all of the specified issues to the end of this report, preserving the order of the array elements. Duplicates will be skipped (the number of skipped elements is available using the method getDuplicatesSize().
    
    Parameters:
    
    issue - the first issue to append
    
    additionalIssues - the additional issue to append
    
    Returns:
    
    this
    
    See Also:
    
    add(Issue)
  - addAll
```
public Report addAll(Collection<? extends Issue> issues)
```
    Appends all of the specified issues to the end of this report, preserving the order of the array elements. Duplicates will be skipped (the number of skipped elements is available using the method getDuplicatesSize().
    
    Parameters:
    
    issues - the issues to append
    
    Returns:
    
    this
    
    See Also:
    
    add(Issue)
  - addAll
```
public Report addAll(Report... reports)
```
    Appends the specified reports to this report. This report will then contain the issues of all specified reports, in the same order. The properties of the specified reports will also be copied.
    
    Parameters:
    
    reports - the reports to append
    
    Returns:
    
    this
    
    See Also:
    
    copyIssuesAndProperties(Report, Report)
  - remove
```
public Issue remove(UUID issueId)
```
    Removes the issue with the specified ID. Note that the number of reported duplicates is not affected by calling this method.
    
    Parameters:
    
    issueId - the ID of the issue
    
    Returns:
    
    the removed element
    
    Throws:
    
    NoSuchElementException - if there is no such issue found
  - findById
```
public Issue findById(UUID issueId)
```
    Returns the issue with the specified ID.
    
    Parameters:
    
    issueId - the ID of the issue
    
    Returns:
    
    the found issue
    
    Throws:
    
    NoSuchElementException - if there is no such issue found
  - findByProperty
```
public Set<Issue> findByProperty(Predicate<? super Issue> criterion)
```
    Finds all issues that match the specified criterion.
    
    Parameters:
    
    criterion - the filter criterion
    
    Returns:
    
    the found issues
  - filter
```
public Report filter(Predicate<? super Issue> criterion)
```
    Finds all issues that match the specified criterion.
    
    Parameters:
    
    criterion - the filter criterion
    
    Returns:
    
    the found issues
  - iterator
```
@NonNull
public Iterator<Issue> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Issue>
  - stream
```
public Stream<Issue> stream()
```
    Creates a new sequential Stream of Issue instances from a Spliterator.
    
    Returns:
    
    a new sequential Stream
  - size
```
public int size()
```
    Returns the number of issues in this container.
    
    Returns:
    
    total number of issues
  - isEmpty
```
public boolean isEmpty()
```
    Returns whether this report is empty.
    
    Returns:
    
    true if this report is empty, false otherwise
    
    See Also:
    
    isNotEmpty()
  - isNotEmpty
```
public boolean isNotEmpty()
```
    Returns whether this report is not empty.
    
    Returns:
    
    true if this report is not empty, false otherwise
    
    See Also:
    
    isEmpty()
  - getSize
```
public int getSize()
```
    Returns the number of issues in this report.
    
    Returns:
    
    total number of issues
  - getDuplicatesSize
```
public int getDuplicatesSize()
```
    Returns the number of duplicates. Every issue that has been added to this report, but already is part of this report (based on equals(Object)) is counted as a duplicate. Duplicates are not stored in this report.
    
    Returns:
    
    total number of duplicates
  - getSizeOf
```
public int getSizeOf(String severity)
```
    Returns the number of issues with the specified severity.
    
    Parameters:
    
    severity - the severity of the issues
    
    Returns:
    
    total number of issues
  - getSizeOf
```
public int getSizeOf(Severity severity)
```
    Returns the number of issues with the specified Severity.
    
    Parameters:
    
    severity - the severity of the issues
    
    Returns:
    
    total number of issues
  - get
```
public Issue get(int index)
```
    Returns the issue with the specified index.
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the issue at the specified index
    
    Throws:
    
    IndexOutOfBoundsException - if there is no element for the given index
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getModules
```
public Set<String> getModules()
```
    Returns the affected modules for all issues.
    
    Returns:
    
    the affected modules
  - hasModules
```
public boolean hasModules()
```
    Returns whether this report contains affected files from more than one module.
    
    Returns:
    
    true if the number of modules is greater than 1, false otherwise
  - getPackages
```
public Set<String> getPackages()
```
    Returns the affected packages for all issues.
    
    Returns:
    
    the affected packages
  - hasPackages
```
public boolean hasPackages()
```
    Returns whether this report contains affected files from more than one package.
    
    Returns:
    
    true if the number of packages is greater than 1, false otherwise
  - getFiles
```
public Set<String> getFiles()
```
    Returns the affected files for all issues.
    
    Returns:
    
    the affected files
  - hasFiles
```
public boolean hasFiles()
```
    Returns whether this report contains more than one affected file.
    
    Returns:
    
    true if the number of affected files is greater than 1, false otherwise
  - getCategories
```
public Set<String> getCategories()
```
    Returns the used categories for all issues.
    
    Returns:
    
    the used categories
  - hasCategories
```
public boolean hasCategories()
```
    Returns whether this report contains issues with different categories.
    
    Returns:
    
    true if the number of categories is greater than 1, false otherwise
  - getTypes
```
public Set<String> getTypes()
```
    Returns the used types for all issues.
    
    Returns:
    
    the used types
  - hasTypes
```
public boolean hasTypes()
```
    Returns whether this report contains issues with different types.
    
    Returns:
    
    true if the number of types is greater than 1, false otherwise
  - getTools
```
public Set<String> getTools()
```
    Returns the names of the tools that did report the issues.
    
    Returns:
    
    the tools
  - hasTools
```
public boolean hasTools()
```
    Returns whether this report contains issues created by different tools.
    
    Returns:
    
    true if the number of tools is greater than 1, false otherwise
  - getSeverities
```
public Set<Severity> getSeverities()
```
    Returns the severities of all issues.
    
    Returns:
    
    the severities
  - hasSeverities
```
public boolean hasSeverities()
```
    Returns whether this report contains issues of different severities.
    
    Returns:
    
    true if the number of severities is greater than 1, false otherwise
  - getProperties
```
public <T> Set<T> getProperties(Function<? super Issue,T> propertiesMapper)
```
    Returns the different values for a given property for all issues.
    
    Type Parameters:
    
    T - type of the property
    
    Parameters:
    
    propertiesMapper - the properties mapper that selects the property
    
    Returns:
    
    the set of different values
    
    See Also:
    
    getFiles()
  - getPropertyCount
```
public <T> Map<T,Integer> getPropertyCount(Function<? super Issue,T> propertiesMapper)
```
    Returns the number of occurrences for every existing value of a given property for all issues.
    
    Type Parameters:
    
    T - type of the property
    
    Parameters:
    
    propertiesMapper - the properties mapper that selects the property to evaluate
    
    Returns:
    
    a mapping of: property value to the number of issues for that value
    
    See Also:
    
    getProperties(Function)
  - groupByProperty
```
public Map<String,Report> groupByProperty(String propertyName)
```
    Groups issues by a specified property. Returns the results as a mapping of property values to a new set of Report for this value.
    
    Parameters:
    
    propertyName - the property to that selects the property to evaluate
    
    Returns:
    
    a mapping of: property value to the number of issues for that value
    
    See Also:
    
    getProperties(Function)
  - copy
```
public Report copy()
```
    Returns a shallow copy of this issue container.
    
    Returns:
    
    a new issue container that contains the same elements in the same order
  - copyEmptyInstance
```
public Report copyEmptyInstance()
```
    Returns a new empty issue container with the same properties as this container. The new issue container is empty and does not contain issues.
    
    Returns:
    
    a new issue container that contains the same properties but no issues
  - logInfo
```
@FormatMethod
public void logInfo(String format,
                                  Object... args)
```
    Logs the specified information message. Use this method to log any useful information when composing this report.
    
    Parameters:
    
    format - A format string
    
    args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.
    
    See Also:
    
    getInfoMessages()
  - logError
```
@FormatMethod
public void logError(String format,
                                   Object... args)
```
    Logs the specified error message. Use this method to log any error when composing this report.
    
    Parameters:
    
    format - A format string
    
    args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.
    
    See Also:
    
    getInfoMessages()
  - logException
```
@FormatMethod
public void logException(Exception exception,
                                       String format,
                                       Object... args)
```
    Logs the specified exception. Use this method to log any exception when composing this report.
    
    Parameters:
    
    exception - the exception to log
    
    format - A format string
    
    args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.
    
    See Also:
    
    getInfoMessages()
  - getInfoMessages
```
public org.eclipse.collections.api.list.ImmutableList<String> getInfoMessages()
```
    Returns the info messages that have been reported since the creation of this set of issues.
    
    Returns:
    
    the info messages
  - getErrorMessages
```
public org.eclipse.collections.api.list.ImmutableList<String> getErrorMessages()
```
    Returns the error messages that have been reported since the creation of this set of issues.
    
    Returns:
    
    the error messages
  - hasErrors
```
public boolean hasErrors()
```
    Returns whether error messages have been reported.
    
    Returns:
    
    true if there are error messages, false otherwise
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Report

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Report

Report

Report

Method Detail

add

addAll

addAll

addAll

remove

findById

findByProperty

filter

iterator

stream

size

isEmpty

isNotEmpty

getSize

getDuplicatesSize

getSizeOf

getSizeOf

get

toString

getModules

hasModules

getPackages

hasPackages

getFiles

hasFiles

getCategories

hasCategories

getTypes

hasTypes

getTools

hasTools

getSeverities

hasSeverities

getProperties

getPropertyCount

groupByProperty

copy

copyEmptyInstance

logInfo

logError

logException

getInfoMessages

getErrorMessages

hasErrors

equals

hashCode