org.sonar.ide.shared
Class AbstractResourceUtils<MODEL>

java.lang.Object
  org.sonar.ide.shared.AbstractResourceUtils<MODEL>

public abstract class AbstractResourceUtils<MODEL>
extends Object

• Java file: groupId:artifactId:packageName.fileNameWithoutExt
  • org.example:myproject:[default].Bar
  • org.example:myproject:org.example.mypackage.Foo
• File: groupId:artifactId:directoryPath/fileName
  • org.example:myproject:[root]/bar.sql
  • org.example:myproject:mydirectory/mysubdirectory/foo.sql

Field Summary

static String	DEFAULT_PACKAGE_NAME Default package name for classes without package definition.
static String	ROOT Default directory name for files in root directory.

Constructor Summary

AbstractResourceUtils()


Method Summary

String	getComponentKey(MODEL file) Returns component key for specified file.
protected abstract String	getDirectoryPath(MODEL file) Returns directory path for specified file.
String	getFileKey(MODEL file) Returns file key for specified file.
protected abstract String	getFileName(MODEL file) Returns name for specified file.
protected abstract String	getPackageName(MODEL file) Returns package name for specified file.
abstract String	getProjectKey(MODEL file) Returns project key for specified file.
String	getProjectKey(String groupId, String artifactId) Deprecated. since 0.2, use getProjectKey(String, String, String) instead of it
String	getProjectKey(String groupId, String artifactId, String branch)
protected abstract boolean	isJavaFile(MODEL file) Returns true, if specified file is a java file, false otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PACKAGE_NAME

public static final String DEFAULT_PACKAGE_NAME

Default package name for classes without package definition.

See Also:

Constant Field Values

ROOT

public static final String ROOT

Default directory name for files in root directory.

See Also:

Constant Field Values

Constructor Detail

AbstractResourceUtils

public AbstractResourceUtils()

Method Detail

getProjectKey

public final String getProjectKey(String groupId,
                                  String artifactId,
                                  String branch)

Parameters:

groupId - groupId

artifactId - artifactId

branch - branch

Returns:

project key or null, if unable to determine

getProjectKey

@Deprecated
public final String getProjectKey(String groupId,
                                             String artifactId)

Deprecated. since 0.2, use getProjectKey(String, String, String) instead of it

Returns project key for specified groupId and artifactId.

Parameters:

groupId - groupId

artifactId - artifactId

Returns:

project key or null, if unable to determine

getComponentKey

public final String getComponentKey(MODEL file)

Returns component key for specified file. Examples:

• org.example:myproject:[default]
• org.example:myproject:org.example.mypackage
• org.example:myproject:[root]
• org.example:myproject:mydirectory/mysubdirectory

Parameters:

file - file

Returns:

component key or null, if unable to determine

getFileKey

public final String getFileKey(MODEL file)

Returns file key for specified file. Examples:

• org.example:myproject:[default].ClassOnDefaultPackage
• org.example:myproject:org.example.mypackage.ClassOne
• org.example:myproject:[root]/foo.sql
• org.example:myproject:mydirectory/mysubdirectory/bar.sql

Parameters:

file - file

Returns:

file key or null, if unable to determine

isJavaFile

protected abstract boolean isJavaFile(MODEL file)

Returns true, if specified file is a java file, false otherwise.

Parameters:

file - file

Returns:

true, if specified file is a java file, false otherwise

getFileName

protected abstract String getFileName(MODEL file)

Returns name for specified file. Examples:

• MyClass
• foo.sql

Parameters:

file - file

Returns:

filename

getPackageName

protected abstract String getPackageName(MODEL file)

Returns package name for specified file. Example: org.example.mypackage

Parameters:

file - file

Returns:

package name (empty for default) or null, if unable to determine

getDirectoryPath

protected abstract String getDirectoryPath(MODEL file)

Returns directory path for specified file. Example: mydirectory/mysubdirectory

Parameters:

file - file

Returns:

directory name (empty for root) or null, if unable to determine

getProjectKey

public abstract String getProjectKey(MODEL file)

Returns project key for specified file. Example: org.example:myproject

Parameters:

file - file

Returns:

project key or null, if unable to determine