Class Api

  • All Implemented Interfaces:
    java.lang.Comparable<Api>

    public class Api
    extends java.lang.Object
    implements java.lang.Comparable<Api>
    Standard API settings for the Alfresco Rest API SCOPE - PUBLIC_API - Reserved for public API - PRIVATE_API - Reserved for private API VERSION - A positive integer starting at 1.
    Author:
    Gethin James
    • Field Detail

      • ALFRESCO_PUBLIC

        public static final Api ALFRESCO_PUBLIC
    • Method Detail

      • getName

        public java.lang.String getName()
      • getVersion

        public int getVersion()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • valueOf

        public static Api valueOf​(java.lang.String apiName,
                                  java.lang.String apiScope,
                                  java.lang.String apiVersion)
                           throws InvalidArgumentException
        Creates an valid instance of the Api object
        Parameters:
        apiName - a String in lowercase
        apiScope - SCOPE
        apiVersion - postive integer
        Returns:
        Api
        Throws:
        InvalidArgumentException
      • compareTo

        public int compareTo​(Api other)
        Specified by:
        compareTo in interface java.lang.Comparable<Api>