Class LocalDocumentReference

    • Constructor Detail

      • LocalDocumentReference

        public LocalDocumentReference​(String spaceName,
                                      String pageName)
        Create a new Document reference in the current wiki.
        Parameters:
        spaceName - the name of the space containing the document, must not be null
        pageName - the name of the document, must not be null
      • LocalDocumentReference

        public LocalDocumentReference​(Iterable<String> spaceNames,
                                      String pageName)
        Create a new Document reference in the current wiki.
        Parameters:
        spaceNames - an ordered list of the names of the spaces containing the document from root space to last one, must not be null
        pageName - the name of the document
        Since:
        7.3M1
      • LocalDocumentReference

        public LocalDocumentReference​(String spaceName,
                                      String pageName,
                                      Locale locale)
        Create a new Document reference in the current wiki.
        Parameters:
        spaceName - the name of the space containing the document, must not be null
        pageName - the name of the document, must not be null
        locale - the new locale for this reference
        Since:
        5.3RC1
      • LocalDocumentReference

        public LocalDocumentReference​(DocumentReference documentReference)
        Parameters:
        documentReference - the full document reference
        Since:
        5.2M2
      • LocalDocumentReference

        public LocalDocumentReference​(EntityReference reference)
        Parameters:
        reference - the reference to clone
        Since:
        5.4RC1
      • LocalDocumentReference

        public LocalDocumentReference​(EntityReference entityReference,
                                      Locale locale)
        Parameters:
        entityReference - the reference
        locale - the new locale for this reference, if null, locale is removed
        Since:
        5.3RC1
      • LocalDocumentReference

        public LocalDocumentReference​(String pageName,
                                      EntityReference spaceReference)
        Create a new Document reference in the current wiki.
        Parameters:
        pageName - the name of the document, must not be null
        spaceReference - the reference of the space, must not be null
        Since:
        7.2M1
      • LocalDocumentReference

        public LocalDocumentReference​(EntityReference reference,
                                      EntityReference parent)
        Clone an LocalDocumentReference, but use the specified parent for its new parent.
        Parameters:
        reference - the reference to clone
        parent - the new parent to use
        Since:
        10.8RC1