com.buschmais.jqassistant.plugin.java.api.model

Interface JavaArtifactFileDescriptor

All Superinterfaces:

com.buschmais.jqassistant.plugin.common.api.model.ArtifactDescriptor, com.buschmais.jqassistant.plugin.common.api.model.ArtifactFileDescriptor, com.buschmais.jqassistant.core.store.api.model.Descriptor, com.buschmais.jqassistant.plugin.common.api.model.FileContainerDescriptor, com.buschmais.jqassistant.plugin.common.api.model.FileDescriptor, com.buschmais.jqassistant.plugin.common.api.model.FileNameDescriptor, com.buschmais.jqassistant.core.store.api.model.FullQualifiedNameDescriptor, JavaDescriptor, com.buschmais.jqassistant.core.store.api.model.NamedDescriptor

All Known Subinterfaces:

JarArchiveDescriptor, JavaClassesDirectoryDescriptor

public interface JavaArtifactFileDescriptor
extends JavaDescriptor, com.buschmais.jqassistant.plugin.common.api.model.ArtifactFileDescriptor

Defines a Java artifact.

Nested Class Summary

Nested classes/interfaces inherited from interface com.buschmais.jqassistant.plugin.common.api.model.ArtifactFileDescriptor

com.buschmais.jqassistant.plugin.common.api.model.ArtifactFileDescriptor.RequiresType

Method Summary

Modifier and Type	Method and Description
long	getNumberOfDependencies() Determine the number of dependencies of this artifact.
List<TypeDescriptor>	getRequiresTypes() Return the list of Java types required by this artifact (i.e. which are referenced from it).
TypeDescriptor	resolveRequiredType(String fqn) Resolves a required type with a given name from a dependency (direct or transitive).

Methods inherited from interface com.buschmais.jqassistant.plugin.common.api.model.ArtifactDescriptor

getClassifier, getDependencies, getDependents, getGroup, getName, getType, getVersion, setClassifier, setGroup, setName, setType, setVersion

Methods inherited from interface com.buschmais.jqassistant.core.store.api.model.FullQualifiedNameDescriptor

getFullQualifiedName, setFullQualifiedName

Methods inherited from interface com.buschmais.jqassistant.plugin.common.api.model.FileContainerDescriptor

find, getContains, getRequires

Methods inherited from interface com.buschmais.jqassistant.plugin.common.api.model.FileNameDescriptor

getFileName, setFileName

Method Detail

getNumberOfDependencies

@Cypher(value="MATCH (artifact:Artifact)-[d:DEPENDS_ON]->(:Artifact) WHERE id(artifact)={this} RETURN count(d)")
long getNumberOfDependencies()

Determine the number of dependencies of this artifact.

Returns:

The number of dependencies.

resolveRequiredType

@Cypher(value="MATCH (type:Type) WHERE type.fqn={fqn} WITH type MATCH (type)<-[:CONTAINS]-(dependency:Artifact), p=shortestPath((artifact)-[:DEPENDS_ON*]->(dependency)) WHERE id(artifact)={this} RETURN type LIMIT 1")
TypeDescriptor resolveRequiredType(String fqn)

Resolves a required type with a given name from a dependency (direct or transitive).

Parameters:

fqn - The fully qualified name.

Returns:

The type.

getRequiresTypes

List<TypeDescriptor> getRequiresTypes()

Return the list of Java types required by this artifact (i.e. which are referenced from it).

Returns:

The list of required java types.