Examples of com.crashnote.core.config.helper.ConfigObject

Package com.crashnote.core.config.helper

Examples of com.crashnote.core.config.helper.ConfigObject

com.crashnote.core.config.helper.ConfigObject
Subtype of {@link ConfigValue} representing an object (dictionary, map)value, as in JSON's { "a" : 42 } syntax.
{@code ConfigObject} implements {@code java.util.Map} soyou can use it like a regular Java map. Or call {@link #unwrapped()} tounwrap the map to a map with plain Java values rather than {@code ConfigValue}.
Like all {@link ConfigValue} subtypes, {@code ConfigObject} is immutable.This makes it threadsafe and you never have to create "defensive copies." The mutator methods from {@link java.util.Map} all throw{@link java.lang.UnsupportedOperationException}.
The {@link ConfigValue#valueType} method on an object returns{@link ConfigValueType#OBJECT}.
In most cases you want to use the {@link Config} interface rather than thisone. Call {@link #toConfig()} to convert a {@code ConfigObject} to a{@code Config}.
The API for a {@code ConfigObject} is in terms of keys, while the API for a{@link Config} is in terms of path expressions. Conceptually,{@code ConfigObject} is a tree of maps from keys to values, while a{@code Config} is a one-level map from paths to values.
Use {@link ConfigUtil#joinPath} and {@link ConfigUtil#splitPath} to convertbetween path expressions and individual path elements (keys).
A {@code ConfigObject} may contain null values, which will have{@link ConfigValue#valueType()} equal to {@link ConfigValueType#NULL}. If {@code get()} returns Java's null then the key was not present in the parsedfile (or wherever this value tree came from). If {@code get()} returns a{@link ConfigValue} with type {@code ConfigValueType#NULL} then the key wasset to null explicitly in the config file.
Do not implement {@code ConfigObject}; it should only be implemented by the config library. Arbitrary implementations will not work because the library internals assume a specific concrete implementation. Also, this interface is likely to grow new methods over time, so third-party implementations will break.

            for (final ConfigValue v : list) {
                writeValue(out, v, (SimpleConfigOrigin) list.origin());
            }
            break;
        case OBJECT:
            final ConfigObject obj = (ConfigObject) value;
            out.writeInt(obj.size());
            for (final Map.Entry<String, ConfigValue> e : obj.entrySet()) {
                out.writeUTF(e.getKey());
                writeValue(out, e.getValue(), (SimpleConfigOrigin) obj.origin());
            }
            break;
        }
    }

View Full Code Here

    }


    // this is the heuristic includer
    @Override
    public ConfigObject include(final ConfigIncludeContext context, final String name) {
        final ConfigObject obj = includeWithoutFallback(context, name);


        // now use the fallback includer if any and merge
        // its result.
        if (fallback != null) {
            return obj.withFallback(fallback.include(context, name));
        } else {
            return obj;
        }
    }

View Full Code Here

        }
    }


    @Override
    public ConfigObject includeURL(final ConfigIncludeContext context, final URL url) {
        final ConfigObject obj = includeURLWithoutFallback(context, url);


        // now use the fallback includer if any and merge
        // its result.
        if (fallback != null && fallback instanceof ConfigIncluderURL) {
            return obj.withFallback(((ConfigIncluderURL) fallback).includeURL(context, url));
        } else {
            return obj;
        }
    }

View Full Code Here

        return ConfigFactory.parseURL(url, context.parseOptions()).root();
    }


    @Override
    public ConfigObject includeFile(final ConfigIncludeContext context, final File file) {
        final ConfigObject obj = includeFileWithoutFallback(context, file);


        // now use the fallback includer if any and merge
        // its result.
        if (fallback != null && fallback instanceof ConfigIncluderFile) {
            return obj.withFallback(((ConfigIncluderFile) fallback).includeFile(context, file));
        } else {
            return obj;
        }
    }

View Full Code Here

        return ConfigFactory.parseFileAnySyntax(file, context.parseOptions()).root();
    }


    @Override
    public ConfigObject includeResources(final ConfigIncludeContext context, final String resource) {
        final ConfigObject obj = includeResourceWithoutFallback(context, resource);


        // now use the fallback includer if any and merge
        // its result.
        if (fallback != null && fallback instanceof ConfigIncluderClasspath) {
            return obj.withFallback(((ConfigIncluderClasspath) fallback).includeResources(context,
                    resource));
        } else {
            return obj;
        }
    }

View Full Code Here

    // this function is a little tricky because there are three places we're
    // trying to use it; for 'include "basename"' in a .conf file, for
    // loading app.{conf,json,properties} from classpath, and for
    // loading app.{conf,json,properties} from the filesystem.
    static ConfigObject fromBasename(final NameSource source, final String name, final ConfigParseOptions options) {
        ConfigObject obj;
        if (name.endsWith(".conf") || name.endsWith(".json") || name.endsWith(".properties")) {
            final ConfigParseable p = source.nameToParseable(name, options);


            obj = p.parse(p.options().setAllowMissing(options.getAllowMissing()));
        } else {
            final ConfigParseable confHandle = source.nameToParseable(name + ".conf", options);
            final ConfigParseable jsonHandle = source.nameToParseable(name + ".json", options);
            final ConfigParseable propsHandle = source.nameToParseable(name + ".properties", options);
            boolean gotSomething = false;
            final List<String> failMessages = new ArrayList<String>();


            final ConfigSyntax syntax = options.getSyntax();


            obj = SimpleConfigObject.empty(SimpleConfigOrigin.newSimple(name));
            if (syntax == null || syntax == ConfigSyntax.CONF) {
                try {
                    obj = confHandle.parse(confHandle.options().setAllowMissing(false)
                            .setSyntax(ConfigSyntax.CONF));
                    gotSomething = true;
                } catch (ConfigException.IO e) {
                    failMessages.add(e.getMessage());
                }
            }


            if (syntax == null || syntax == ConfigSyntax.JSON) {
                try {
                    final ConfigObject parsed = jsonHandle.parse(jsonHandle.options()
                            .setAllowMissing(false).setSyntax(ConfigSyntax.JSON));
                    obj = obj.withFallback(parsed);
                    gotSomething = true;
                } catch (ConfigException.IO e) {
                    failMessages.add(e.getMessage());
                }
            }


            if (syntax == null || syntax == ConfigSyntax.PROPERTIES) {
                try {
                    final ConfigObject parsed = propsHandle.parse(propsHandle.options()
                            .setAllowMissing(false).setSyntax(ConfigSyntax.PROPERTIES));
                    obj = obj.withFallback(parsed);
                    gotSomething = true;
                } catch (ConfigException.IO e) {
                    failMessages.add(e.getMessage());

View Full Code Here

TOP

Related Classes of com.crashnote.core.config.helper.ConfigObject

com.crashnote.core.config.helper.impl.SerializedConfigValue

com.crashnote.core.config.helper.impl.SimpleIncluder

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.