Interface UserReferenceResolver<T>

  • Type Parameters:
    T - the type of the raw user reference

    @Role
    public interface UserReferenceResolver<T>
    Convert a raw representation of a user reference into a UserReference object (for example converts a String containing a user name into a Document User Reference).
    Since:
    12.2
    Version:
    $Id: 487cffa7ebcaf5f9c55462ac4a925cfaede34d5e $
    • Field Detail

      • TYPE_STRING

        static final ParameterizedType TYPE_STRING
        Type instance for UserReferenceResolver<String>.
        Since:
        14.1RC1
      • TYPE_DOCUMENT_REFERENCE

        static final ParameterizedType TYPE_DOCUMENT_REFERENCE
        Type instance for UserReferenceResolver<DocumentReference>.
        Since:
        14.1RC1
    • Method Detail

      • resolve

        UserReference resolve​(T rawReference,
                              Object... parameters)
        Parameters:
        rawReference - the raw representation of a user reference to convert. If null then resolves to the current user reference
        parameters - optional parameters that have a meaning only for the specific resolver implementation used (for example a Document User Reference resolver accepting a user name as a string will also take as parameter a Wiki Reference defining in which wiki the user belongs to)
        Returns:
        the resulting User Reference object