com.github.anno4j.schema_parsing.naming

Class MethodNameBuilder

java.lang.Object

com.github.anno4j.schema_parsing.naming.IdentifierBuilder

com.github.anno4j.schema_parsing.naming.MethodNameBuilder

public class MethodNameBuilder
extends IdentifierBuilder

Generates Java compliant method names for resources.

Method Summary

Methods

Modifier and Type	Method and Description
static MethodNameBuilder	forObjectRepository(ObjectConnection connection) Returns a builder object that operates on the connected repository.
static MethodNameBuilder	forObjectRepository(ObjectRepository repository) Returns a builder object that operates on the given repository.
com.squareup.javapoet.MethodSpec	getJavaPoetMethodSpec(String prefix, ResourceObject resource, OntGenerationConfig config, boolean pluralName) Returns a JavaPoet MethodSpec object for a property described by the builders resource.

Methods inherited from class com.github.anno4j.schema_parsing.naming.IdentifierBuilder

capitalizedIdentifier, capitalizedPluralIdentifier, lowercaseIdentifier, lowercasePluralIdentifier, packageName

Methods inherited from class java.lang.Object

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

Method Detail

forObjectRepository

public static MethodNameBuilder forObjectRepository(ObjectRepository repository)
                                             throws org.openrdf.repository.RepositoryException

Returns a builder object that operates on the given repository.

Parameters:

repository - The repository to use, e.g. for name disambiguation.

Returns:

An instance of the builder.

Throws:

org.openrdf.repository.RepositoryException - Thrown if an error occurs while opening a connection to the repository.

forObjectRepository

public static MethodNameBuilder forObjectRepository(ObjectConnection connection)

Returns a builder object that operates on the connected repository.

Parameters:

connection - A connection to the repository to use, e.g. for name disambiguation.

Returns:

An instance of the builder.

getJavaPoetMethodSpec

public com.squareup.javapoet.MethodSpec getJavaPoetMethodSpec(String prefix,
                                                     ResourceObject resource,
                                                     OntGenerationConfig config,
                                                     boolean pluralName)
                                                       throws org.openrdf.repository.RepositoryException

Returns a JavaPoet MethodSpec object for a property described by the builders resource. Only the name of the method is set in the method specification, i.e. this is a equivalent to MethodSpec.methodBuilder(prefix + ci).build();, where ci is a capitalized identifier for the resource. The generation of the methods name if preferably done on basis of the RDFS label set. If it is not possible to derive a meaningful name, then an unambiguous name is picked.

Parameters:

prefix - The part preceding the properties name in the method name, e.g. "set", "addAll", ...

resource - The property resource for which to generate a (name-only) method specification.

config - The configuration according to which to chose the name.

pluralName - Whether a plural form should be picked for the methods name.

Returns:

A MethodSpec object for a method for the resource.

Throws:

org.openrdf.repository.RepositoryException - Thrown if an error occurs while querying the repository.