Package com.puppycrawl.tools.checkstyle.site

Class AllCheckSummaries.CheckInfo

java.lang.Object

com.puppycrawl.tools.checkstyle.site.AllCheckSummaries.CheckInfo

Enclosing class:

AllCheckSummaries

private static final class AllCheckSummaries.CheckInfo
extends Object

Data holder for each Check module entry.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	isHolder	Whether the module is a holder type.
private final String	link	Documentation link.
private final String	simpleName	Simple name of the check.
private final String	summary	Short summary text.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CheckInfo(String simpleName, String link, String summary, boolean isHolder)	Constructs an info record.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

simpleName

private final String simpleName

Simple name of the check.

link

private final String link

Documentation link.

summary

private final String summary

Short summary text.

isHolder

private final boolean isHolder

Whether the module is a holder type.

Constructor Details

CheckInfo

private CheckInfo(String simpleName,
 String link,
 String summary,
 boolean isHolder)

Constructs an info record.

Parameters:

simpleName - check simple name

link - documentation link

summary - module summary

isHolder - whether holder