com.liferay.frontend.js.loader.modules.extender.npm

Class ModuleNameUtil

java.lang.Object

com.liferay.frontend.js.loader.modules.extender.npm.ModuleNameUtil

public class ModuleNameUtil
extends java.lang.Object

Provides utility methods to manipulate module names.

There are several concepts that must be understood when using this class:

• module name: the name of an NPM module deployed to the portal
  • Syntax: {module name}
  • Example: lib/index
• module file name: the file name implementing an NPM module deployed to the portal
  • Syntax: {module file name}
  • Example: lib/index.js
• package ID: the unique ID of an NPM package deployed to the portal
  • Syntax: {bundle ID}/{package name}@{package version}
  • Example: 625/isarray@1.0.0
• module ID: the unique ID of an NPM module deployed to the portal
  • Syntax: {bundle ID}/{package name}@{package version}/{module name}
  • Example: 625/isarray@1.0.0/lib/index

Constructor Summary

Constructors

Constructor and Description
ModuleNameUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getModuleId(JSPackage jsPackage, java.lang.String moduleName) Returns the module ID with the NPM package and module name.
static java.lang.String	getPackageName(java.lang.String moduleName) Returns the package name portion of a full module name.
static java.lang.String	getPackagePath(java.lang.String moduleName) Returns the path portion of a full module name.
static boolean	isLocalModuleName(java.lang.String moduleName)
static boolean	isReservedModuleName(java.lang.String moduleName)
static java.lang.String	toFileName(java.lang.String moduleName) Returns the file name implementing the module.
static java.lang.String	toModuleName(java.lang.String fileName) Returns the module's name given the file name implementing it.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleNameUtil

public ModuleNameUtil()

Method Detail

getModuleId

public static java.lang.String getModuleId(JSPackage jsPackage,
                                           java.lang.String moduleName)

Returns the module ID with the NPM package and module name.

Parameters:

jsPackage - the NPM package

moduleName - the module's name

Returns:

the module ID

getPackageName

public static java.lang.String getPackageName(java.lang.String moduleName)

Returns the package name portion of a full module name.

Example:

 
 getPackageName("isarray/lib/index") returns "isarray"
 
 

Parameters:

moduleName - the module's name

Returns:

the package name or null if the module name is a reserved or local one

getPackagePath

public static java.lang.String getPackagePath(java.lang.String moduleName)

Returns the path portion of a full module name.

Example:

 
 getPackagePath("isarray/lib/index") returns "lib/index"
 
 

Parameters:

moduleName - the module's name

Returns:

the path portion of a full module name or null in any other case

isLocalModuleName

public static boolean isLocalModuleName(java.lang.String moduleName)

isReservedModuleName

public static boolean isReservedModuleName(java.lang.String moduleName)

toFileName

public static java.lang.String toFileName(java.lang.String moduleName)

Returns the file name implementing the module.

Parameters:

moduleName - the module's name

Returns:

the file name

toModuleName

public static java.lang.String toModuleName(java.lang.String fileName)

Returns the module's name given the file name implementing it.

Parameters:

fileName - the file name implementing the module

Returns:

the module's name