Package org.apache.maven.api.model

Class ReportSet

java.lang.Object
org.apache.maven.api.model.ConfigurationContainer
org.apache.maven.api.model.ReportSet
All Implemented Interfaces:
Serializable, InputLocationTracker
@Experimental @Generated @ThreadSafe @Immutable public class ReportSet extends ConfigurationContainer implements Serializable, InputLocationTracker
Represents a set of reports and configuration to be used to generate them.
See Also:

  • Constructor Details

  • Method Details

    • getId

      public String getId()
      The unique id for this report set, to be used during POM inheritance and profile injection for merging of report sets.
      Returns:
      a String

    • getReports

      @Nonnull public List<String> getReports()
      The list of reports from this plugin which should be generated from this set.
      Returns:
      a List<String>

    • getLocation

      public InputLocation getLocation(Object key)
      Gets the location of the specified field in the input source.
      Specified by:
      getLocation in interface InputLocationTracker
      Overrides:
      getLocation in class ConfigurationContainer

    • getLocationKeys

      public Set<Object> getLocationKeys()
      Gets the keys of the locations of the input source.
      Overrides:
      getLocationKeys in class ConfigurationContainer

    • with

      @Nonnull public ReportSet.Builder with()
      Creates a new builder with this object as the basis.
      Overrides:
      with in class ConfigurationContainer
      Returns:
      a Builder

    • withInherited

      @Nonnull public ReportSet withInherited(String inherited)
      Creates a new ReportSet instance using the specified inherited.
      Overrides:
      withInherited in class ConfigurationContainer
      Parameters:
      inherited - the new String to use
      Returns:
      a ReportSet with the specified inherited

    • withConfiguration

      @Nonnull public ReportSet withConfiguration(XmlNode configuration)
      Creates a new ReportSet instance using the specified configuration.
      Overrides:
      withConfiguration in class ConfigurationContainer
      Parameters:
      configuration - the new XmlNode to use
      Returns:
      a ReportSet with the specified configuration

    • withId

      @Nonnull public ReportSet withId(String id)
      Creates a new ReportSet instance using the specified id.
      Parameters:
      id - the new String to use
      Returns:
      a ReportSet with the specified id

    • withReports

      @Nonnull public ReportSet withReports(Collection<String> reports)
      Creates a new ReportSet instance using the specified reports.
      Parameters:
      reports - the new Collection<String> to use
      Returns:
      a ReportSet with the specified reports

    • newInstance

      @Nonnull public static ReportSet newInstance()
      Creates a new ReportSet instance. Equivalent to newInstance(true).
      Returns:
      a new ReportSet
      See Also:

    • newInstance

      @Nonnull public static ReportSet newInstance(boolean withDefaults)
      Creates a new ReportSet instance using default values or not. Equivalent to newBuilder(withDefaults).build().
      Parameters:
      withDefaults - the boolean indicating whether default values should be used
      Returns:
      a new ReportSet

    • newBuilder

      @Nonnull public static ReportSet.Builder newBuilder()
      Creates a new ReportSet builder instance. Equivalent to newBuilder(true).
      Returns:
      a new Builder
      See Also:

    • newBuilder

      @Nonnull public static ReportSet.Builder newBuilder(boolean withDefaults)
      Creates a new ReportSet builder instance using default values or not.
      Parameters:
      withDefaults - the boolean indicating whether default values should be used
      Returns:
      a new Builder

    • newBuilder

      @Nonnull public static ReportSet.Builder newBuilder(ReportSet from)
      Creates a new ReportSet builder instance using the specified object as a basis. Equivalent to newBuilder(from, false).
      Parameters:
      from - the ReportSet instance to use as a basis
      Returns:
      a new Builder

    • newBuilder

      @Nonnull public static ReportSet.Builder newBuilder(ReportSet from, boolean forceCopy)
      Creates a new ReportSet builder instance using the specified object as a basis.
      Parameters:
      from - the ReportSet instance to use as a basis
      forceCopy - the boolean indicating if a copy should be forced
      Returns:
      a new Builder

    • toString

      public String toString()
      Overrides:
      toString in class Object