com.thomasjensen.checkstyle.addons.checks.misc

Class DecomposedPath

java.lang.Object

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

@Immutable
public class DecomposedPath
extends java.lang.Object

Encapsulates the components of a checked file path.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getFileExtensions()
java.lang.String	getMdlPath()
java.lang.String	getModulePath()
java.lang.String	getSimpleFilename()
java.util.List<java.lang.String>	getSpecificFolders()
java.lang.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
                      java.lang.String pModulePath,
                      @Nonnull
                      java.lang.String pMdlPath,
                      @Nonnull
                      java.lang.String pSpecificPath,
                      @Nonnull
                      java.lang.String pSimpleFilename,
                      @Nonnull
                      java.util.Set<java.lang.String> pFileExtensions,
                      @Nonnull
                      java.util.List<java.lang.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 java.util.Set<java.lang.String> getFileExtensions()

getMdlPath

@Nonnull
public java.lang.String getMdlPath()

getModulePath

@Nonnull
public java.lang.String getModulePath()

getSimpleFilename

@Nonnull
public java.lang.String getSimpleFilename()

getSpecificFolders

@Nonnull
public java.util.List<java.lang.String> getSpecificFolders()

getSpecificPath

@Nonnull
public java.lang.String getSpecificPath()