com.thomasjensen.checkstyle.addons.checks.misc

Class MdlJsonConfig

java.lang.Object

com.thomasjensen.checkstyle.addons.checks.misc.MdlJsonConfig

All Implemented Interfaces:

SelfValidating

public class MdlJsonConfig
extends java.lang.Object
implements SelfValidating

Deserialized version of the directories.json.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MdlJsonConfig.MdlSpec An MDL Spec specifies the characteristics of one directory in the module directory layout, for example src/main/java.
static class	MdlJsonConfig.Settings Encapsulates the general settings which are supported in a directories.json.
static class	MdlJsonConfig.SpecElement The allow and deny lists in each MDL path specification are composed of elements of SpecElements.

Constructor Summary

Constructors

Constructor and Description
MdlJsonConfig()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComment()
MdlJsonConfig.Settings	getSettings()
java.util.Map<java.lang.String,MdlJsonConfig.MdlSpec>	getStructure()
void	validate() Perform self-validation.

Methods inherited from class java.lang.Object

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

Constructor Detail

MdlJsonConfig

public MdlJsonConfig()

Method Detail

getComment

@CheckForNull
public java.lang.String getComment()

getSettings

@Nonnull
public MdlJsonConfig.Settings getSettings()

getStructure

@Nonnull
public java.util.Map<java.lang.String,MdlJsonConfig.MdlSpec> getStructure()

validate

public void validate()
              throws ConfigValidationException

Description copied from interface: SelfValidating

Perform self-validation.

Specified by:

validate in interface SelfValidating

Throws:

ConfigValidationException - an error is detected