com.android.utils

Class SdkUtils

java.lang.Object

com.android.utils.SdkUtils

public class SdkUtils
extends java.lang.Object

Miscellaneous utilities used by the Android SDK tools

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILENAME_PREFIX Prefix in comments which mark the source locations for merge results
static java.util.List<java.lang.String>	IMAGE_EXTENSIONS

Constructor Summary

Constructors

Constructor and Description
SdkUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	camelCaseToConstantName(java.lang.String camelCaseName) Translates a camel case name (e.g.
static java.lang.String	constantNameToCamelCase(java.lang.String constantName) Translates a Java / C++ constant name (e.g.
static java.lang.String	constantNameToXmlName(java.lang.String constantName) Translates a Java / C++ constant name (e.g.
static java.lang.String	createPathComment(java.io.File file, boolean includePadding) Creates the path comment XML string.
static boolean	endsWith(java.lang.CharSequence sequence, java.lang.CharSequence suffix) Returns true if the given sequence ends with the given suffix (case sensitive).
static boolean	endsWith(java.lang.CharSequence sequence, int endOffset, java.lang.CharSequence suffix) Returns true if the given sequence ends at the given offset with the given suffix (case sensitive)
static boolean	endsWithIgnoreCase(java.lang.String string, java.lang.String suffix) Returns true if the given string ends with the given suffix, using a case-insensitive comparison.
static java.lang.String	escapePropertyValue(java.lang.String value) Escapes the given property file value (right hand side of property assignment) as required by the property file format (e.g.
static java.lang.String	fileNameToResourceName(java.lang.String fileName) Returns the basename of the given filename, unless it's a dot-file such as ".svn".
static java.net.URL	fileToUrl(java.io.File file) Returns the corresponding URL for the given File
static java.lang.String	fileToUrlString(java.io.File file) Returns the corresponding URL string for the given File
static java.lang.String	getResourceFieldName(java.lang.String resourceName) Get the R field name from a resource name, since AAPT will flatten the namespace, turning dots, dashes and colons into _
static java.lang.String	globToRegexp(java.lang.String glob)
static boolean	hasImageExtension(java.lang.String path) Returns true if the given file path points to an image file recognized by Android.
static boolean	isBitmapFile(java.io.File file) Returns true if the given file represents a bitmap drawable file
static boolean	isServiceKey(java.lang.String name)
static boolean	startsWithIgnoreCase(java.lang.String string, java.lang.String prefix) Returns true if the given string starts with the given prefix, using a case-insensitive comparison.
static java.io.File	urlToFile(java.lang.String url) Returns the corresponding File for the given file:// url
static java.io.File	urlToFile(java.net.URL url)
static java.lang.String	wrap(java.lang.String text, int firstLineWidth, int nextLineWidth, java.lang.String hangingIndent) Wraps the given text at the given line width, with an optional hanging indent.
static java.lang.String	wrap(java.lang.String text, int lineWidth, java.lang.String hangingIndent) Wraps the given text at the given line width, with an optional hanging indent.
static java.lang.String	xmlNameToConstantName(java.lang.String xmlName) Translates an XML name (e.g.

Methods inherited from class java.lang.Object

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

Field Detail

FILENAME_PREFIX

public static final java.lang.String FILENAME_PREFIX

Prefix in comments which mark the source locations for merge results

See Also:

Constant Field Values

IMAGE_EXTENSIONS

public static final java.util.List<java.lang.String> IMAGE_EXTENSIONS

Constructor Detail

SdkUtils

public SdkUtils()

Method Detail

endsWithIgnoreCase

public static boolean endsWithIgnoreCase(@NonNull
                                         java.lang.String string,
                                         @NonNull
                                         java.lang.String suffix)

Returns true if the given string ends with the given suffix, using a case-insensitive comparison.

Parameters:

string - the full string to be checked

suffix - the suffix to be checked for

Returns:

true if the string case-insensitively ends with the given suffix

endsWith

public static boolean endsWith(@NonNull
                               java.lang.CharSequence sequence,
                               @NonNull
                               java.lang.CharSequence suffix)

Returns true if the given sequence ends with the given suffix (case sensitive).

Parameters:

sequence - the character sequence to be checked

suffix - the suffix to look for

Returns:

true if the given sequence ends with the given suffix

endsWith

public static boolean endsWith(@NonNull
                               java.lang.CharSequence sequence,
                               int endOffset,
                               @NonNull
                               java.lang.CharSequence suffix)

Returns true if the given sequence ends at the given offset with the given suffix (case sensitive)

Parameters:

sequence - the character sequence to be checked

endOffset - the offset at which the sequence is considered to end

suffix - the suffix to look for

Returns:

true if the given sequence ends with the given suffix

startsWithIgnoreCase

public static boolean startsWithIgnoreCase(@NonNull
                                           java.lang.String string,
                                           @NonNull
                                           java.lang.String prefix)

Returns true if the given string starts with the given prefix, using a case-insensitive comparison.

Parameters:

string - the full string to be checked

prefix - the prefix to be checked for

Returns:

true if the string case-insensitively starts with the given prefix

wrap

@NonNull
public static java.lang.String wrap(@NonNull
                                             java.lang.String text,
                                             int lineWidth,
                                             @Nullable
                                             java.lang.String hangingIndent)

Wraps the given text at the given line width, with an optional hanging indent.

Parameters:

text - the text to be wrapped

lineWidth - the number of characters to wrap the text to

hangingIndent - the hanging indent (to be used for the second and subsequent lines in each paragraph, or null if not known

Returns:

the string, wrapped

wrap

@NonNull
public static java.lang.String wrap(@NonNull
                                             java.lang.String text,
                                             int firstLineWidth,
                                             int nextLineWidth,
                                             @Nullable
                                             java.lang.String hangingIndent)

Wraps the given text at the given line width, with an optional hanging indent.

Parameters:

text - the text to be wrapped

firstLineWidth - the line width to wrap the text to (on the first line)

nextLineWidth - the line width to wrap the text to (on subsequent lines). This does not include the hanging indent, if any.

hangingIndent - the hanging indent (to be used for the second and subsequent lines in each paragraph, or null if not known

Returns:

the string, wrapped

urlToFile

@NonNull
public static java.io.File urlToFile(@NonNull
                                              java.lang.String url)
                                       throws java.net.MalformedURLException

Returns the corresponding File for the given file:// url

Parameters:

url - the URL string, e.g. file://foo/bar

Returns:

the corresponding File (which may or may not exist)

Throws:

java.net.MalformedURLException - if the URL string is malformed or is not a file: URL

urlToFile

@NonNull
public static java.io.File urlToFile(@NonNull
                                              java.net.URL url)
                                       throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

fileToUrlString

public static java.lang.String fileToUrlString(@NonNull
                                               java.io.File file)
                                        throws java.net.MalformedURLException

Returns the corresponding URL string for the given File

Parameters:

file - the file to look up the URL for

Returns:

the corresponding URL

Throws:

java.net.MalformedURLException - in very unexpected cases

fileToUrl

public static java.net.URL fileToUrl(@NonNull
                                     java.io.File file)
                              throws java.net.MalformedURLException

Returns the corresponding URL for the given File

Parameters:

file - the file to look up the URL for

Returns:

the corresponding URL

Throws:

java.net.MalformedURLException - in very unexpected cases

createPathComment

public static java.lang.String createPathComment(@NonNull
                                                 java.io.File file,
                                                 boolean includePadding)
                                          throws java.net.MalformedURLException

Creates the path comment XML string. Note that it does not escape characters such as & and <; those are expected to be escaped by the caller (for example, handled by a call to Document.createComment(String))

Parameters:

file - the file to create a path comment for

includePadding - whether to include padding. The final comment recognized by error recognizers expect padding between the <!-- and the start marker (From:); you can disable padding if the caller already is in a context where the padding has been added.

Returns:

the corresponding XML contents of the string

Throws:

java.net.MalformedURLException

xmlNameToConstantName

public static java.lang.String xmlNameToConstantName(java.lang.String xmlName)

Translates an XML name (e.g. xml-name) into a Java / C++ constant name (e.g. XML_NAME)

Parameters:

xmlName - the hyphen separated lower case xml name.

Returns:

the equivalent constant name.

camelCaseToConstantName

public static java.lang.String camelCaseToConstantName(java.lang.String camelCaseName)

Translates a camel case name (e.g. xmlName) into a Java / C++ constant name (e.g. XML_NAME)

Parameters:

camelCaseName - the camel case name.

Returns:

the equivalent constant name.

constantNameToCamelCase

public static java.lang.String constantNameToCamelCase(java.lang.String constantName)

Translates a Java / C++ constant name (e.g. XML_NAME) into camel case name (e.g. xmlName)

Parameters:

constantName - the constant name.

Returns:

the equivalent camel case name.

constantNameToXmlName

public static java.lang.String constantNameToXmlName(java.lang.String constantName)

Translates a Java / C++ constant name (e.g. XML_NAME) into a XML case name (e.g. xml-name)

Parameters:

constantName - the constant name.

Returns:

the equivalent XML name.

getResourceFieldName

@NonNull
public static java.lang.String getResourceFieldName(@NonNull
                                                             java.lang.String resourceName)

Get the R field name from a resource name, since AAPT will flatten the namespace, turning dots, dashes and colons into _

Parameters:

resourceName - the name to convert

Returns:

the corresponding R field name

fileNameToResourceName

public static java.lang.String fileNameToResourceName(@NonNull
                                                      java.lang.String fileName)

Returns the basename of the given filename, unless it's a dot-file such as ".svn".

Parameters:

fileName - the file name to extract the basename from

Returns:

the basename (the filename without the file extension)

hasImageExtension

public static boolean hasImageExtension(java.lang.String path)

Returns true if the given file path points to an image file recognized by Android. See http://developer.android.com/guide/appendix/media-formats.html for details.

Parameters:

path - the filename to be tested

Returns:

true if the file represents an image file

isBitmapFile

public static boolean isBitmapFile(@NonNull
                                   java.io.File file)

Returns true if the given file represents a bitmap drawable file

Parameters:

file - the file to be checked

Returns:

true if the given file is an xml file

escapePropertyValue

@NonNull
public static java.lang.String escapePropertyValue(@NonNull
                                                            java.lang.String value)

Escapes the given property file value (right hand side of property assignment) as required by the property file format (e.g. escapes colons and backslashes)

Parameters:

value - the value to be escaped

Returns:

the escaped value

globToRegexp

@NonNull
public static java.lang.String globToRegexp(@NonNull
                                                     java.lang.String glob)

isServiceKey

public static boolean isServiceKey(@NonNull
                                   java.lang.String name)