io.spine.js.generate.output.snippet

Class Import

java.lang.Object

io.spine.js.generate.output.CodeLine

io.spine.js.generate.output.snippet.Import

public class Import
extends CodeLine

An import of a file or a library.

The import is anonymous, but can be transformed into a named one.

Method Summary

Modifier and Type	Method and Description
java.lang.String	content() Obtains the value of the line.
static Import	fileRelativeTo(io.spine.code.fs.js.FileName fileToImport, io.spine.code.fs.js.FileName relativeTo) Obtains an import of a file relative to another file.
static Import	fileRelativeToRoot(io.spine.code.fs.js.FileName file) Obtains an import of a file assuming the name is relative to the current directory.
static Import	library(java.lang.String libraryName) Obtains an import of a library.
java.lang.String	namedAs(java.lang.String importName) Obtains the named version of the import.
Import	toDefault() Converts the import to the default import.

Methods inherited from class io.spine.js.generate.output.CodeLine

emptyLine, equals, hashCode, of, toString

Methods inherited from class java.lang.Object

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

Method Detail

fileRelativeToRoot

public static Import fileRelativeToRoot(io.spine.code.fs.js.FileName file)

Obtains an import of a file assuming the name is relative to the current directory.

fileRelativeTo

public static Import fileRelativeTo(io.spine.code.fs.js.FileName fileToImport,
                                    io.spine.code.fs.js.FileName relativeTo)

Obtains an import of a file relative to another file.

Parameters:

fileToImport - the name of the file to import

relativeTo - the name of the file to compose the relative import path

library

public static Import library(java.lang.String libraryName)

Obtains an import of a library.

It is allowed to specify just a library name like google-protobuf or the path to a library file, e.g. google-protobuf/proto-file.js.

content

public java.lang.String content()

Description copied from class: CodeLine

Obtains the value of the line.

Specified by:

content in class CodeLine

toDefault

public Import toDefault()

Converts the import to the default import.

Does nothing if the import is already default.

namedAs

public java.lang.String namedAs(java.lang.String importName)

Obtains the named version of the import.

Parameters:

importName - the name for the import