org.keycloak.common.util.StringPropertyReplacer クラス

org.keycloak.common.util.StringPropertyReplacer 連携図

静的公開メンバ関数
static String	replaceProperties (final String string)
static String	replaceProperties (final String string, final Properties props)

静的公開変数類
static final String	NEWLINE = System.getProperty("line.separator", "\n")

静的非公開メンバ関数
static String	resolveCompositeKey (String key, Properties props)

静的非公開変数類
static final String	FILE_SEPARATOR = File.separator
static final String	PATH_SEPARATOR = File.pathSeparator
static final String	FILE_SEPARATOR_ALIAS = "/"
static final String	PATH_SEPARATOR_ALIAS = ":"
static final int	NORMAL = 0
static final int	SEEN_DOLLAR = 1
static final int	IN_BRACKET = 2

詳解

A utility class for replacing properties in strings.

著者

Jason Dillon

Scott Stark

Claudio Vesco

Adrian Brock

Dimitris Andreadis

バージョン

Revision

2898

関数詳解

replaceProperties() [1/2]

static String org.keycloak.common.util.StringPropertyReplacer.replaceProperties ( final String  string )

inlinestatic

Go through the input string and replace any occurance of ${p} with the System.getProperty(p) value. If there is no such property p defined, then the ${p} reference will remain unchanged.

If the property reference is of the form ${p:v} and there is no such property p, then the default value v will be returned.

If the property reference is of the form ${p1,p2} or ${p1,p2:v} then the primary and the secondary properties will be tried in turn, before returning either the unchanged input, or the default value.

The property ${/} is replaced with System.getProperty("file.separator") value and the property ${:} is replaced with System.getProperty("path.separator").

引数

string

- the string with possible ${} references

戻り値

the input string with all property references replaced if any. If there are no valid references the input string will be returned.

    {
        return replaceProperties(string, null);
    }

replaceProperties() [2/2]

static String org.keycloak.common.util.StringPropertyReplacer.replaceProperties ( final String  string, final Properties  props  )

inlinestatic

Go through the input string and replace any occurance of ${p} with the props.getProperty(p) value. If there is no such property p defined, then the ${p} reference will remain unchanged.

If the property reference is of the form ${p:v} and there is no such property p, then the default value v will be returned.

If the property reference is of the form ${p1,p2} or ${p1,p2:v} then the primary and the secondary properties will be tried in turn, before returning either the unchanged input, or the default value.

The property ${/} is replaced with System.getProperty("file.separator") value and the property ${:} is replaced with System.getProperty("path.separator").

引数

string	- the string with possible ${} references
props	- the source for ${x} property ref values, null means use System.getProperty()

戻り値

the input string with all property references replaced if any. If there are no valid references the input string will be returned.

    {
        final char[] chars = string.toCharArray();
        StringBuilder buffer = new StringBuilder();
        boolean properties = false;
        int state = NORMAL;
        int start = 0;
        for (int i = 0; i < chars.length; ++i)
        {
            char c = chars[i];

            // Dollar sign outside brackets
            if (c == '$' && state != IN_BRACKET)
                state = SEEN_DOLLAR;

                // Open bracket immediatley after dollar
            else if (c == '{' && state == SEEN_DOLLAR)
            {
                buffer.append(string.substring(start, i - 1));
                state = IN_BRACKET;
                start = i - 1;
            }

            // No open bracket after dollar
            else if (state == SEEN_DOLLAR)
                state = NORMAL;

                // Closed bracket after open bracket
            else if (c == '}' && state == IN_BRACKET)
            {
                // No content
                if (start + 2 == i)
                {
                    buffer.append("${}"); // REVIEW: Correct?
                }
                else // Collect the system property
                {
                    String value = null;

                    String key = string.substring(start + 2, i);

                    // check for alias
                    if (FILE_SEPARATOR_ALIAS.equals(key))
                    {
                        value = FILE_SEPARATOR;
                    }
                    else if (PATH_SEPARATOR_ALIAS.equals(key))
                    {
                        value = PATH_SEPARATOR;
                    }
                    else
                    {
                        // check from the properties
                        if (props != null)
                            value = props.getProperty(key);
                        else
                            value = System.getProperty(key);

                        if (value == null)
                        {
                            // Check for a default value ${key:default}
                            int colon = key.indexOf(':');
                            if (colon > 0)
                            {
                                String realKey = key.substring(0, colon);
                                if (props != null)
                                    value = props.getProperty(realKey);
                                else
                                    value = System.getProperty(realKey);

                                if (value == null)
                                {
                                    // Check for a composite key, "key1,key2"
                                    value = resolveCompositeKey(realKey, props);

                                    // Not a composite key either, use the specified default
                                    if (value == null)
                                        value = key.substring(colon+1);
                                }
                            }
                            else
                            {
                                // No default, check for a composite key, "key1,key2"
                                value = resolveCompositeKey(key, props);
                            }
                        }
                    }

                    if (value != null)
                    {
                        properties = true;
                        buffer.append(value);
                    }
                    else
                    {
                        buffer.append("${");
                        buffer.append(key);
                        buffer.append('}');
                    }

                }
                start = i + 1;
                state = NORMAL;
            }
        }

        // No properties
        if (!properties)
            return string;

        // Collect the trailing characters
        if (start != chars.length)
            buffer.append(string.substring(start, chars.length));

        // Done
        return buffer.toString();
    }

resolveCompositeKey()

static String org.keycloak.common.util.StringPropertyReplacer.resolveCompositeKey ( String  key, Properties  props  )

inlinestaticprivate

Try to resolve a "key" from the provided properties by checking if it is actually a "key1,key2", in which case try first "key1", then "key2". If all fails, return null.

It also accepts "key1," and ",key2".

引数

key	the key to resolve
props	the properties to use

戻り値

the resolved key or null

    {
        String value = null;

        // Look for the comma
        int comma = key.indexOf(',');
        if (comma > -1)
        {
            // If we have a first part, try resolve it
            if (comma > 0)
            {
                // Check the first part
                String key1 = key.substring(0, comma);
                if (props != null)
                    value = props.getProperty(key1);
                else
                    value = System.getProperty(key1);
            }
            // Check the second part, if there is one and first lookup failed
            if (value == null && comma < key.length() - 1)
            {
                String key2 = key.substring(comma + 1);
                if (props != null)
                    value = props.getProperty(key2);
                else
                    value = System.getProperty(key2);
            }
        }
        // Return whatever we've found or null
        return value;
    }

メンバ詳解

FILE_SEPARATOR

final String org.keycloak.common.util.StringPropertyReplacer.FILE_SEPARATOR = File.separator

staticprivate

File separator value

FILE_SEPARATOR_ALIAS

final String org.keycloak.common.util.StringPropertyReplacer.FILE_SEPARATOR_ALIAS = "/"

staticprivate

File separator alias

IN_BRACKET

final int org.keycloak.common.util.StringPropertyReplacer.IN_BRACKET = 2

staticprivate

NEWLINE

final String org.keycloak.common.util.StringPropertyReplacer.NEWLINE = System.getProperty("line.separator", "\n")

static

New line string constant

NORMAL

final int org.keycloak.common.util.StringPropertyReplacer.NORMAL = 0

staticprivate

PATH_SEPARATOR

final String org.keycloak.common.util.StringPropertyReplacer.PATH_SEPARATOR = File.pathSeparator

staticprivate

Path separator value

PATH_SEPARATOR_ALIAS

final String org.keycloak.common.util.StringPropertyReplacer.PATH_SEPARATOR_ALIAS = ":"

staticprivate

Path separator alias

SEEN_DOLLAR

final int org.keycloak.common.util.StringPropertyReplacer.SEEN_DOLLAR = 1

staticprivate

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/common/util/StringPropertyReplacer.java