com.thomasjensen.checkstyle.addons.checks.misc

Class DecomposedPath

java.lang.Object

com.thomasjensen.checkstyle.addons.checks.misc.DecomposedPath

@Immutable
public class DecomposedPath
extends Object

Encapsulates the components of a checked file path.

Constructor Summary

Constructors

Constructor and Description
DecomposedPath(String pModulePath, String pMdlPath, String pSpecificPath, String pSimpleFilename, Set<String> pFileExtensions, List<String> pSpecificFolders) Constructor.

Method Summary

Modifier and Type	Method and Description
Set<String>	getFileExtensions()
String	getMdlPath()
String	getModulePath()
String	getSimpleFilename()
List<String>	getSpecificFolders()
String	getSpecificPath()

Methods inherited from class java.lang.Object

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

Constructor Detail

DecomposedPath

public DecomposedPath(@Nonnull
                      String pModulePath,
                      @Nonnull
                      String pMdlPath,
                      @Nonnull
                      String pSpecificPath,
                      @Nonnull
                      String pSimpleFilename,
                      @Nonnull
                      Set<String> pFileExtensions,
                      @Nonnull
                      List<String> pSpecificFolders)

Constructor.

Parameters:

pModulePath - the module path, for example subsystem1/module1

pMdlPath - the MDL path, for example src/main/java

pSpecificPath - the specific path, for example com/acme/Foo.java

pSimpleFilename - the simple file name, for example Foo.java

pFileExtensions - the list of file extensions, for example java, but it could be a list if multiple dots are present (e.g. tar.gz, gz)

pSpecificFolders - the simple names of all folders on the specific path, for example com, acme

Method Detail

getFileExtensions

@Nonnull
public Set<String> getFileExtensions()

getMdlPath

@Nonnull
public String getMdlPath()

getModulePath

@Nonnull
public String getModulePath()

getSimpleFilename

@Nonnull
public String getSimpleFilename()

getSpecificFolders

@Nonnull
public List<String> getSpecificFolders()

getSpecificPath

@Nonnull
public String getSpecificPath()