io.spine.tools.code.structure

Class ExternalModule

java.lang.Object

io.spine.tools.code.structure.ExternalModule

public final class ExternalModule
extends java.lang.Object

An external library module used in a project.

An external module is typically provided by a package manager, such as NPM or Pub.

Constructor Summary

Constructors

Constructor and Description
ExternalModule(java.lang.String name, java.util.Collection<DirectoryPattern> directories) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
io.spine.code.fs.FileReference	fileInModule(io.spine.code.fs.FileReference fileReference) Obtains the file reference within this module.
int	hashCode()
java.lang.String	name() Obtains the name of the module.
static com.google.common.collect.ImmutableList<ExternalModule>	predefinedModules() All the modules in spineWeb() and spineUsers().
boolean	provides(io.spine.code.fs.FileReference fileReference) Checks if the module provides the referenced file.
static ExternalModule	spineUsers() The Spine Users module.
static ExternalModule	spineWeb() The Spine Web module.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalModule

public ExternalModule(java.lang.String name,
                      java.util.Collection<DirectoryPattern> directories)

Creates a new instance.

Parameters:

name - the name of the module

directories - patterns of directories provided by the module

Method Detail

fileInModule

public io.spine.code.fs.FileReference fileInModule(io.spine.code.fs.FileReference fileReference)

Obtains the file reference within this module.

Parameters:

fileReference - the relative file reference

Returns:

the file reference in this module

Throws:

java.lang.IllegalStateException - if the file is not provided by the module

provides

public boolean provides(io.spine.code.fs.FileReference fileReference)

Checks if the module provides the referenced file.

Parameters:

fileReference - the file to check

Returns:

true if the module provides the file

name

public java.lang.String name()

Obtains the name of the module.

spineWeb

public static ExternalModule spineWeb()

The Spine Web module.

spineUsers

public static ExternalModule spineUsers()

The Spine Users module.

predefinedModules

public static com.google.common.collect.ImmutableList<ExternalModule> predefinedModules()

All the modules in spineWeb() and spineUsers().

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object