## Uses of Interface
org.modeshape.jcr.federation.spi.PageWriter

- Packages that use PageWriter
  Package | Description
  --- | ---
  org.modeshape.connector.git |
  org.modeshape.jcr.federation |
  org.modeshape.jcr.federation.spi | This package provides a Service Provider Interface (SPI) for connectors to external systems.

- - ### Uses of PageWriter in org.modeshape.connector.git

    Methods in org.modeshape.connector.git with parameters of type PageWriter
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | GitFunction.`addCommitsAsPageOfChildren(org.eclipse.jgit.api.Git git, org.eclipse.jgit.lib.Repository repository, CallSpecification spec, PageWriter writer, PageKey pageKey)` Add an additional page of commits in the history names of the tags as children of the current node.
    `Document` | PageableGitFunction.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, PageWriter writer, Values values, PageKey pageKey)`
    `Document` | GitTree.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, PageWriter writer, Values values, PageKey pageKey)`
    `Document` | GitHistory.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, PageWriter writer, Values values, PageKey pageKey)`
    `Document` | GitCommitDetails.`execute(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, CallSpecification spec, PageWriter writer, Values values, PageKey pageKey)`

  - ### Uses of PageWriter in org.modeshape.jcr.federation

    Classes in org.modeshape.jcr.federation that implement PageWriter
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FederatedDocumentWriter` Default implementation of the `DocumentWriter` interface.

  - ### Uses of PageWriter in org.modeshape.jcr.federation.spi

    Subinterfaces of PageWriter in org.modeshape.jcr.federation.spi
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `DocumentWriter` A writer which can create and manipulate the structure of `EditableDocument` instances, that should be used by connectors when they want to return the information regarding external nodes.

    Methods in org.modeshape.jcr.federation.spi that return PageWriter
    Modifier and Type | Method and Description
    --- | ---
    `PageWriter` | PageWriter.`addChild(String id, Name name)` Add a child with the given id and name to the underlying document.
    `PageWriter` | PageWriter.`addChild(String id, String name)` Add a child with the given id and name to the underlying document.
    `PageWriter` | PageWriter.`addPage(String parentId, int nextPageOffset, long blockSize, long totalChildCount)` Create a reference to a separate page of children in its underlying document.
    `PageWriter` | PageWriter.`addPage(String parentId, String nextPageOffset, long blockSize, long totalChildCount)` Create a reference to a separate page of children in its underlying document.
    `protected PageWriter` | Connector.`newPageDocument(PageKey pageKey)` Obtain a new `PageWriter` that can be used to construct a page of children, typically within the `Pageable.getChildren(PageKey)` method.
    `PageWriter` | PageWriter.`removeChild(String id)` Remove a child from this document.
    `PageWriter` | PageWriter.`setChildren(LinkedHashMap<String,Name> children)` Set an ordered of (childId, childName) for the underlying document.
    `PageWriter` | PageWriter.`setChildren(List<? extends Document> children)` Set the list of children for the underlying document.

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.