Package com.tick42.glue.core.interop
Class MethodDefinition
- java.lang.Object
-
- com.tick42.glue.core.interop.MethodDefinition
-
public final class MethodDefinition extends Object
Describes an Interop method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMethodDefinition.Builderstatic classMethodDefinition.BuilderBase<B extends MethodDefinition.BuilderBase<B>>
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MethodDefinition.Builderbuilder(String name)Crates aMethodDefinition.Builderfor specified name.static MethodDefinitionforName(String method)Builds a method definition for specified name.StringgetAccepts()Returns the signature of accepted arguments.StringgetDescription()Returns a description of what the method does.StringgetDisplayName()Map<String,Object>getMetadata()Returns additional metadata key-value pairs.StringgetName()Returns the name of the method.Set<String>getObjectTypes()Returns the entities this method is meant to work with.StringgetReturns()Returns the signature of returned result.StringtoString()
-
-
-
Method Detail
-
forName
public static MethodDefinition forName(String method)
Builds a method definition for specified name.- Parameters:
method- name of the method, must not benull- Returns:
- a method definition
-
builder
public static MethodDefinition.Builder builder(String name)
Crates aMethodDefinition.Builderfor specified name.- Parameters:
name- name of the method, must not benull- Returns:
- a method definition builder
-
getName
public String getName()
Returns the name of the method.- Returns:
- the name of the method, never
null
-
getObjectTypes
public Set<String> getObjectTypes()
Returns the entities this method is meant to work with.- Returns:
- the entities this method is meant to work with, never
null
-
getMetadata
public Map<String,Object> getMetadata()
Returns additional metadata key-value pairs.- Returns:
- additional metadata key-value pairs, never
null - Since:
- 1.4.3
-
getDescription
public String getDescription()
Returns a description of what the method does.- Returns:
- a description of what the method does, may be
null
-
getDisplayName
public String getDisplayName()
-
getAccepts
public String getAccepts()
Returns the signature of accepted arguments.- Returns:
- the signature of accepted arguments, may be
null - Since:
- 1.2
-
getReturns
public String getReturns()
Returns the signature of returned result.- Returns:
- signature of returned result, may be
null - Since:
- 1.2
-
-