Package org.apache.jackrabbit.oak.api

Interface Descriptors

  • All Known Implementing Classes:
    AggregatingDescriptors, GenericDescriptors
    public interface Descriptors
    Repository descriptors interface that is used to support providing the repository descriptors of Repository

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull java.lang.String[] getKeys()
      Returns a string array holding all descriptor keys available for this implementation, both the standard descriptors defined by the string constants in this interface and any implementation-specific descriptors.
      @Nullable javax.jcr.Value getValue​(@NotNull java.lang.String key)
      The value of a single-value descriptor is found by passing the key for that descriptor to this method.
      @Nullable javax.jcr.Value[] getValues​(@NotNull java.lang.String key)
      The value array of a multi-value descriptor is found by passing the key for that descriptor to this method.
      boolean isSingleValueDescriptor​(@NotNull java.lang.String key)
      Returns true if key is a valid single-value descriptor; otherwise returns false
      boolean isStandardDescriptor​(@NotNull java.lang.String key)
      Returns true if key is a standard descriptor defined by the string constants in this interface and false if it is either a valid implementation-specific key or not a valid key.

    • Method Detail

      • getKeys

        @NotNull
@NotNull java.lang.String[] getKeys()
        Returns a string array holding all descriptor keys available for this implementation, both the standard descriptors defined by the string constants in this interface and any implementation-specific descriptors. Used in conjunction with getValue(String key) and getValues(String key) to query information about this repository implementation.
        Returns:
        a string array holding all descriptor keys.

      • isStandardDescriptor

        boolean isStandardDescriptor​(@NotNull
                             @NotNull java.lang.String key)
        Returns true if key is a standard descriptor defined by the string constants in this interface and false if it is either a valid implementation-specific key or not a valid key.
        Parameters:
        key - a descriptor key.
        Returns:
        whether key is a standard descriptor.

      • isSingleValueDescriptor

        boolean isSingleValueDescriptor​(@NotNull
                                @NotNull java.lang.String key)
        Returns true if key is a valid single-value descriptor; otherwise returns false
        Parameters:
        key - a descriptor key.
        Returns:
        whether the specified descriptor is multi-valued.
        Since:
        JCR 2.0

      • getValue

        @Nullable
@Nullable javax.jcr.Value getValue​(@NotNull
                                   @NotNull java.lang.String key)
        The value of a single-value descriptor is found by passing the key for that descriptor to this method. If key is the key of a multi-value descriptor or not a valid key this method returns null.
        Parameters:
        key - a descriptor key.
        Returns:
        The value of the indicated descriptor

      • getValues

        @Nullable
@Nullable javax.jcr.Value[] getValues​(@NotNull
                                      @NotNull java.lang.String key)
        The value array of a multi-value descriptor is found by passing the key for that descriptor to this method. If key is the key of a single-value descriptor then this method returns that value as an array of size one. If key is not a valid key this method returns null.
        Parameters:
        key - a descriptor key.
        Returns:
        the value array for the indicated descriptor