Interface Location

  • All Known Implementing Classes:
    AbstractLocation, DefaultLocation, TextFileLocation, WorkbookLocation

    public interface Location
    Base interface used to describe a location inside a resource.

    It is composed of 2 parts:

    • external: the path to a resource,
    • internal: the anchor that optionally designates something inside the resource.
    Author:
    Damien Carbonne
    • Field Detail

      • UNDEFINED

        static final Location UNDEFINED
    • Method Detail

      • getPath

        String getPath()
        Returns:
        The external part of the location, the path of the designated resource.
        It is typically a file name, an URI, a kind of 'absolute' identifier.
      • getAnchor

        String getAnchor()
        Returns:
        The internal part of the location, inside the resource. It may be null.
      • hasAnchor

        default boolean hasAnchor()
        Returns:
        true if this location has a meaningful anchor.