io.inversion

Class Op

java.lang.Object

io.inversion.Op

All Implemented Interfaces:

java.lang.Comparable<Op>

public final class Op
extends java.lang.Object
implements java.lang.Comparable<Op>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Op.OpFunction

Constructor Summary

Constructors

Constructor and Description
Op()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Op o)
static int	functionAsInt(Op.OpFunction func)
io.inversion.utils.Path	getActionPathMatch()
java.util.List<org.apache.commons.lang3.tuple.Triple<Action,io.inversion.utils.Path,java.lang.Boolean>>	getActionPathMatches()
java.util.List<Action>	getActions()
Api	getApi()
Collection	getCollection()
io.inversion.utils.Path	getCollectionPathMatch()
Db	getDb()
io.inversion.utils.Path	getDbPathMatch()
java.lang.String	getDescription()
Endpoint	getEndpoint()
io.inversion.utils.Path	getEndpointPathMatch()
Engine	getEngine()
Op.OpFunction	getFunction()
java.lang.String	getMethod()
java.lang.String	getName()
java.lang.String	getOperationPath()
Param	getParam(Param.In in, java.lang.String key)
java.util.List<Param>	getParams()
io.inversion.utils.Path	getPath()
int	getPathParamCount()
java.util.List<Param>	getPathParams(int pathIndex)
java.lang.String	getPathParamValue(java.lang.String key)
Relationship	getRelationship()
boolean	hasParams(Param.In in, java.lang.String... keys)
boolean	isEpAction(Action action)
boolean	isInternal() Indicates this operation should not be called from clients directly but may be used for internal calls.
boolean	matches(Request req, io.inversion.utils.Path path)
void	removeParam(Param param)
java.lang.String	toString()
Op	withActionMatch(Action action, io.inversion.utils.Path actionMatchPath, java.lang.Boolean isEpAction)
Op	withActionPathMatch(io.inversion.utils.Path actionPathMatch)
Op	withApi(Api api)
Op	withCollection(Collection collection)
Op	withCollectionPathMatch(io.inversion.utils.Path collectionPathMatch)
Op	withDb(Db db)
Op	withDbMatchPath(io.inversion.utils.Path dbMatchPath)
Op	withDbPathMatch(io.inversion.utils.Path dbPathMatch)
Op	withDescription(java.lang.String description)
Op	withEndpoint(Endpoint endpoint)
Op	withEndpointPathMatch(io.inversion.utils.Path endpointPathMatch)
Op	withEngine(Engine engine)
Op	withFunction(Op.OpFunction function)
Op	withInternal(boolean internal)
Op	withMethod(java.lang.String method)
Op	withName(java.lang.String name)
Op	withParam(Param param)
Op	withPath(io.inversion.utils.Path path)
Op	withRelationship(Relationship relationship)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Op

public Op()

Method Detail

matches

public boolean matches(Request req,
                       io.inversion.utils.Path path)

getOperationPath

public java.lang.String getOperationPath()

isInternal

public boolean isInternal()

Indicates this operation should not be called from clients directly but may be used for internal calls.

Returns:

true if internal is true or either endpoint.isInternal() or collection.isInternal() are true

withInternal

public Op withInternal(boolean internal)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getActionPathMatch

public io.inversion.utils.Path getActionPathMatch()

withActionPathMatch

public Op withActionPathMatch(io.inversion.utils.Path actionPathMatch)

withActionMatch

public Op withActionMatch(Action action,
                          io.inversion.utils.Path actionMatchPath,
                          java.lang.Boolean isEpAction)

getActions

public java.util.List<Action> getActions()

hasParams

public boolean hasParams(Param.In in,
                         java.lang.String... keys)

getPathParamValue

public java.lang.String getPathParamValue(java.lang.String key)

withParam

public Op withParam(Param param)

getParams

public java.util.List<Param> getParams()

removeParam

public void removeParam(Param param)

getPathParams

public java.util.List<Param> getPathParams(int pathIndex)

getParam

public Param getParam(Param.In in,
                      java.lang.String key)

getPathParamCount

public int getPathParamCount()

compareTo

public int compareTo(Op o)

Specified by:

compareTo in interface java.lang.Comparable<Op>

functionAsInt

public static int functionAsInt(Op.OpFunction func)

getName

public java.lang.String getName()

withName

public Op withName(java.lang.String name)

getMethod

public java.lang.String getMethod()

withMethod

public Op withMethod(java.lang.String method)

getFunction

public Op.OpFunction getFunction()

withFunction

public Op withFunction(Op.OpFunction function)

getPath

public io.inversion.utils.Path getPath()

withPath

public Op withPath(io.inversion.utils.Path path)

getEndpointPathMatch

public io.inversion.utils.Path getEndpointPathMatch()

withEndpointPathMatch

public Op withEndpointPathMatch(io.inversion.utils.Path endpointPathMatch)

getEndpoint

public Endpoint getEndpoint()

withEndpoint

public Op withEndpoint(Endpoint endpoint)

getCollection

public Collection getCollection()

withCollection

public Op withCollection(Collection collection)

getRelationship

public Relationship getRelationship()

withRelationship

public Op withRelationship(Relationship relationship)

getApi

public Api getApi()

withApi

public Op withApi(Api api)

getDbPathMatch

public io.inversion.utils.Path getDbPathMatch()

withDbMatchPath

public Op withDbMatchPath(io.inversion.utils.Path dbMatchPath)

getDb

public Db getDb()

withDb

public Op withDb(Db db)

getEngine

public Engine getEngine()

withEngine

public Op withEngine(Engine engine)

withDbPathMatch

public Op withDbPathMatch(io.inversion.utils.Path dbPathMatch)

getCollectionPathMatch

public io.inversion.utils.Path getCollectionPathMatch()

withCollectionPathMatch

public Op withCollectionPathMatch(io.inversion.utils.Path collectionPathMatch)

getDescription

public java.lang.String getDescription()

withDescription

public Op withDescription(java.lang.String description)

getActionPathMatches

public java.util.List<org.apache.commons.lang3.tuple.Triple<Action,io.inversion.utils.Path,java.lang.Boolean>> getActionPathMatches()

isEpAction

public boolean isEpAction(Action action)