TinkerServiceRegistry.TinkerServiceFactory (Apache TinkerPop 3.7.0-SNAPSHOT API)

java.lang.Object
- org.apache.tinkerpop.gremlin.tinkergraph.services.TinkerServiceRegistry.TinkerServiceFactory<I,R>

All Implemented Interfaces:

AutoCloseable, Service.ServiceFactory<I,R>

Direct Known Subclasses:

TinkerDegreeCentralityFactory, TinkerServiceRegistry.LambdaServiceFactory, TinkerTextSearchFactory

Enclosing class:

TinkerServiceRegistry
```
public abstract static class TinkerServiceRegistry.TinkerServiceFactory<I,R>
extends Object
implements Service.ServiceFactory<I,R>
```

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map`	`describeParams`
`protected AbstractTinkerGraph`	`graph`
`protected String`	`name`
`protected Map<Service.Type,Set<TraverserRequirement>>`	`requirements`

Constructor Summary

Constructors
Modifier Constructor Description

protected TinkerServiceFactory(AbstractTinkerGraph graph, String name)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TinkerServiceRegistry.TinkerServiceFactory`	`addDescribeParams(Map describeParams)`
`TinkerServiceRegistry.TinkerServiceFactory`	`addRequirements(Service.Type type, TraverserRequirement... requirements)`
`Map`	`describeParams()`	Return a description of any service call parameters.
`String`	`getName()`	Get the name of this service.
`Set<TraverserRequirement>`	`getRequirements(Service.Type type)`	Return any `TraverserRequirement`s necessary for this service call for the supplied execution `Service.Type`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.service.Service.ServiceFactory
close, createService, getRequirementsByType, getSupportedTypes

Field Detail

graph

protected final AbstractTinkerGraph graph

name
```
protected final String name
```

describeParams
```
protected final Map describeParams
```

requirements

protected final Map<Service.Type,Set<TraverserRequirement>> requirements

Constructor Detail

TinkerServiceFactory

protected TinkerServiceFactory(AbstractTinkerGraph graph,
                               String name)

Method Detail
- getName
```
public String getName()
```
  Description copied from interface: Service.ServiceFactory
  
  Get the name of this service.
  
  Specified by:
  
  getName in interface Service.ServiceFactory<I,R>
- addDescribeParams
```
public TinkerServiceRegistry.TinkerServiceFactory addDescribeParams(Map describeParams)
```
- addRequirements
```
public TinkerServiceRegistry.TinkerServiceFactory addRequirements(Service.Type type,
                                                                  TraverserRequirement... requirements)
```
- getRequirements
```
public Set<TraverserRequirement> getRequirements(Service.Type type)
```
  Description copied from interface: Service.ServiceFactory
  
  Return any TraverserRequirements necessary for this service call for the supplied execution Service.Type.
  
  Specified by:
  
  getRequirements in interface Service.ServiceFactory<I,R>
- describeParams
```
public Map describeParams()
```
  Description copied from interface: Service.ServiceFactory
  
  Return a description of any service call parameters.
  
  Specified by:
  
  describeParams in interface Service.ServiceFactory<I,R>