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 and Description
static class	Api.SCOPE

Field Summary

Fields

Modifier and Type	Field and Description
static Api	ALFRESCO_PUBLIC

Method Summary

Modifier and Type	Method and 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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

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 lowercase

apiScope - SCOPE

apiVersion - postive integer

Returns:

Api

Throws:

InvalidArgumentException

compareTo

public int compareTo(Api other)

Specified by:

compareTo in interface Comparable<Api>