Object

eu.cdevreeze.tqa.docbuilder.jvm

PartialUriConverters

Related Doc: package jvm

Permalink

object PartialUriConverters

Partial URI converters, typically converting an HTTP or HTTPS URI to a local file URI. The implementations use SimpleCatalog objects to perform the actual URI conversions.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PartialUriConverters
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type PartialUriConverter = (URI) ⇒ Option[URI]

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def fromCatalog(catalog: SimpleCatalog): PartialUriConverter

    Permalink

    Turns the given catalog into a partial URI converter.

    Turns the given catalog into a partial URI converter. It can return absolute and/or relative URIs. Relative URIs are typically meant to be resolved inside ZIP files.

    The partial URI converter is only defined for URIs matching URI start strings in the catalog.

  10. def fromLocalMirrorInZipFile(parentPathOption: Option[URI]): PartialUriConverter

    Permalink

    Like fromLocalMirrorRootDirectory, but the resulting partial URI converter returns relative URIs.

    Like fromLocalMirrorRootDirectory, but the resulting partial URI converter returns relative URIs. Such a partial URI converter is useful in ZIP files that contain mirrored sites.

    If the local mirror does not start at the root (of the ZIP file), parameter parentPathOption is used to specify the relative path of the local mirror.

  11. def fromLocalMirrorRootDirectory(rootDir: File): PartialUriConverter

    Permalink

    Returns a partial URI converter that converts (absolute) HTTP and HTTPS URIs to file URIs.

    Returns a partial URI converter that converts (absolute) HTTP and HTTPS URIs to file URIs. Such a conversion assumes the existence of a local mirror of one or more internet sites, where the host name in the parameter URI is an immediate sub-directory of the local root directory, and where the URI scheme (such as HTTP) and port number, if any, do not occur in the local mirror. The conversion then returns the URI in the local mirror that corresponds to the parameter URI.

    The partial URI converter is defined for all URIs that are HTTP(S) URIs (with host).

    For example, if the URI is "http://www.example.com/a/b/c.xml", then the URI is rewritten using a SimpleCatalog which rewrites URI start "http://www.example.com/" to the rewrite prefix, as file protocol URI, for sub-directory "www.example.com" of the given root directory.

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. def identity: PartialUriConverter

    Permalink
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped