object NoOpPathTranslator extends PathTranslator
Path translator implementation that returns all paths unmodified.
Used in scenarios where only a single document gets rendered and there is no use case for cross references or static or versioned documents.
- Alphabetic
- By Inheritance
- NoOpPathTranslator
- PathTranslator
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
forReferencePath(path: Path): PathTranslator
Creates a copy of this path translator that uses the specified reference path for resolving relative paths.
Creates a copy of this path translator that uses the specified reference path for resolving relative paths. All other aspect of translation logic should behave the same as in this instance.
- Definition Classes
- NoOpPathTranslator → PathTranslator
-
def
getAttributes(path: Path): Option[PathAttributes]
Retrieves the attributes for the specified path in the context of the current virtual tree of documents.
Retrieves the attributes for the specified path in the context of the current virtual tree of documents. If there is no document or tree associated with the specified path, the result will be empty.
Mostly used by implementations of this trait, but accessible publicly for some less common scenarios, e.g. in directive implementations.
- Definition Classes
- NoOpPathTranslator → PathTranslator
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
translate(input: RelativePath): RelativePath
Translates the specified relative path of an input document to the corresponding output path.
Translates the specified relative path of an input document to the corresponding output path.
Translator implementations resolve the relative path in relation to a reference path, which implies that there is a dedicated path translator instance per output document. Using
forReferencePath
a copy of this translator that uses a different path as reference can be created cheaply.- Definition Classes
- NoOpPathTranslator → PathTranslator
-
def
translate(input: Path): Path
Translates the specified path of an input document to the corresponding output path.
Translates the specified path of an input document to the corresponding output path.
- Definition Classes
- NoOpPathTranslator → PathTranslator
-
def
translate(target: Target): Target
Translates the specified target pointing to an input document to a target pointing to an output document.
Translates the specified target pointing to an input document to a target pointing to an output document. Might turn an internal target into an external one in cases where it points to a document that is not rendered for the current target format, but for the site output. In this case it will point to the corresponding location of the hosted site, in case a
siteBaseURL
is configured.- Definition Classes
- PathTranslator
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated