Package org.alfresco.rest.framework
Class Api
- java.lang.Object
-
- org.alfresco.rest.framework.Api
-
- All Implemented Interfaces:
Comparable<Api>
public class Api extends Object implements 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Api.SCOPE
-
Field Summary
Fields Modifier and Type Field Description static Api
ALFRESCO_PUBLIC
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(Api other)
boolean
equals(Object obj)
String
getName()
Api.SCOPE
getScope()
int
getVersion()
int
hashCode()
String
toString()
static Api
valueOf(String apiName, String apiScope, String apiVersion)
Creates an valid instance of the Api object
-
-
-
Field Detail
-
ALFRESCO_PUBLIC
public static final Api ALFRESCO_PUBLIC
-
-
Method Detail
-
getName
public String getName()
-
getScope
public Api.SCOPE getScope()
-
getVersion
public int getVersion()
-
valueOf
public static Api valueOf(String apiName, String apiScope, String apiVersion) throws InvalidArgumentException
Creates an valid instance of the Api object- Parameters:
apiName
- a String in lowercaseapiScope
- SCOPEapiVersion
- postive integer- Returns:
- Api
- Throws:
InvalidArgumentException
-
compareTo
public int compareTo(Api other)
- Specified by:
compareTo
in interfaceComparable<Api>
-
-