com.hello2morrow.sonargraph.plugin.api

Interface IElementAccess

All Known Subinterfaces:

IAggregatedDependencyAccess, ICppSourceFileAccess, IDependencyAccess, IDirectoryAccess, IExternalAccess, IFieldAccess, IGenericClassAccess, IGenericFieldAccess, IGenericFunctionAccess, IGenericMethodAccess, IGenericPackageAccess, IGenericProgrammingElementAccess, IJavaClassFileAccess, IJavaFieldAccess, IJavaLogicalModuleAccess, IJavaLogicalPackageAccess, IJavaMethodAccess, IJavaModuleAccess, IJavaSourceFileAccess, IJavaSyntheticTypeAccess, IJavaTypeAccess, ILogicalExternalAccess, ILogicalModuleAccess, ILogicalNamespaceAccess, ILogicalProgrammingElementAccess, ILogicalSystemAccess, IMethodAccess, IModuleAccess, INamedElementAccess, INamespaceFragmentAccess, IProgrammingElementAccess, IPythonClassAccess, IPythonExternalAccess, IPythonFieldAccess, IPythonFunctionAccess, IPythonMethodAccess, IPythonModuleAccess, IPythonSourceFileAccess, IPythonVariableAccess, IRoutineAccess, ISourceFileAccess, ITypeAccess

All Known Implementing Classes:

AbstractCoreAccess, AggregatedDependencyAccess, CoreAccess, CppAccess, CppClassAccess, CppCompilationUnitFragmentAccess, CppComponentAccess, CppDirectoryFragmentAccess, CppEnumAccess, CppEnumConstantAccess, CppFieldAccess, CppFunctionAccess, CppIncludeDirectoryAccess, CppLogicalModuleAccess, CppLogicalNamespaceAccess, CppMacroAccess, CppMacroInvocationAccess, CppMethodAccess, CppModuleAccess, CppRootDirectoryPathAccess, CppSourceFileAccess, CppStructAccess, CppStructuredTypeAccess, CppTypeAccess, CppUnionAccess, CppVariableAccess, CppWeakRootDirectoryAccess, CSharpAccess, CSharpClassAccess, CSharpDelegateAccess, CSharpEnumAccess, CSharpEnumConstantAccess, CSharpEventAccess, CSharpFieldAccess, CSharpInterfaceAccess, CSharpLogicalModuleAccess, CSharpLogicalNamespaceAccess, CSharpMethodAccess, CSharpModuleAccess, CSharpPropertyAccess, CSharpSourceFileAccess, CSharpStructAccess, CSharpTypeAccess, DependencyAccess, DirectoryAccess, DirectoryFragmentAccess, ElementAccess, ExternalAccess, ExternalElementContainerAccess, FieldAccess, GenericClassAccess, GenericFieldAccess, GenericFunctionAccess, GenericMethodAccess, GenericPackageAccess, GenericProgrammingElementAccess, JavaAccess, JavaClassFileAccess, JavaFieldAccess, JavaLogicalModuleAccess, JavaLogicalPackageAccess, JavaMethodAccess, JavaModuleAccess, JavaSourceFileAccess, JavaSyntheticTypeAccess, JavaTypeAccess, LogicalExternalAccess, LogicalModuleAccess, LogicalModuleProgrammingElementAccess, LogicalNamespaceAccess, LogicalProgrammingElementAccess, LogicalSystemAccess, LogicalSystemProgrammingElementAccess, MethodAccess, ModuleAccess, NamespaceFragmentAccess, ProgrammingElementAccess, PythonAccess, PythonClassAccess, PythonExternalAccess, PythonFieldAccess, PythonFunctionAccess, PythonMethodAccess, PythonModuleAccess, PythonSourceFileAccess, PythonVariableAccess, RootAccess, RoutineAccess, SourceFileAccess, TypeAccess

public interface IElementAccess

Base interface for all named elements in a software system

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() The (full) name without (potential) signature parts.
java.lang.String	getNameWithSignature() The (full) name with (potential) signature parts.
java.lang.String	getShortName() The short name without (potential) signature parts.
java.lang.String	getShortNameWithSignature() The short name with potential signature parts.
boolean	ignoreIssues() Issues of elements matched by the issue filter (workspace setup) should be ignored.
boolean	isExcluded() The exclusion state.
boolean	isExternal() The external state.

Method Detail

getName

java.lang.String getName()

The (full) name without (potential) signature parts.

Returns:

the (full) name without signature parts.

getShortName

java.lang.String getShortName()

The short name without (potential) signature parts.

Returns:

the short name without signature parts.

getNameWithSignature

java.lang.String getNameWithSignature()

The (full) name with (potential) signature parts.

Returns:

the (full) name with signature parts.

getShortNameWithSignature

java.lang.String getShortNameWithSignature()

The short name with potential signature parts.

Returns:

the short name with signature parts.

isExternal

boolean isExternal()

The external state.

Returns:

'true' if external.

isExcluded

boolean isExcluded()

The exclusion state.

Returns:

'true' if excluded.

ignoreIssues

boolean ignoreIssues()

Issues of elements matched by the issue filter (workspace setup) should be ignored.

Returns:

'true' if this element's issues are to be ignored.