Package qupath.lib.images.servers

Interface ImageServerBuilder.ServerBuilder<T>

Type Parameters:
T -
All Known Implementing Classes:
ImageServerBuilder.AbstractServerBuilder, ImageServerBuilder.DefaultImageServerBuilder
Enclosing interface:
ImageServerBuilder<T>
public static interface ImageServerBuilder.ServerBuilder<T>
Interface that defines a class encapsulating all that is required to build an ImageServer.

Instances should be sufficiently lightweight that they can be easily serialized to/from JSON for storage within projects.

Instances should also be immutable.

  • Method Details

    • build

      ImageServer<T> build() throws Exception
      Build a new ImageServer instance.
      Returns:
      Throws:
      Exception

    • getURIs

      Collection<URI> getURIs()
      Get a list of URIs required by this builder. The purpose is to identify resources that are required.
      Returns:
      See Also:

    • updateURIs

      ImageServerBuilder.ServerBuilder<T> updateURIs(Map<URI,URI> updateMap)
      Update the URIs required by this builder. The purpose is to handle resources that may have moved (e.g. files). Because ServerBuilder should be immutable, this returns a new builder.
      Parameters:
      updateMap -
      Returns:
      See Also:

    • getMetadata

      default Optional<ImageServerMetadata> getMetadata()
      Optional method to get metadata associated with the image. The default implementation returns an empty optional, which indicates that the server itself must be built before metadata is available.

      Subclasses may override this to provide metadata more efficiently.

      Returns:
      the metadata, or an empty optional if this is not available