com.oracle.bedrock.runtime.java.container.DelegatingProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bedrock-runtime Show documentation
Interfaces, classes and resources to construct, inspect and manage runtime processes.
There is a newer version: 7.0.5
/*
 * File: DelegatingProperties.java
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * The contents of this file are subject to the terms and conditions of 
 * the Common Development and Distribution License 1.0 (the "License").
 *
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the License by consulting the LICENSE.txt file
 * distributed with this file, or by consulting https://oss.oracle.com/licenses/CDDL
 *
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file LICENSE.txt.
 *
 * MODIFICATIONS:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 */

package com.oracle.bedrock.runtime.java.container;

import com.oracle.bedrock.annotations.Internal;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.Reader;
import java.io.Writer;
import java.util.Collection;
import java.util.Enumeration;
import java.util.Map;
import java.util.Properties;
import java.util.Set;

/**
 * A {@link DelegatingProperties} is a {@link Properties} implementation
 * that delegates {@link Properties} method calls onto appropriate
 * {@link ContainerScope#getProperties()} methods.
 * 
 * Copyright (c) 2013. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 * @author Jonathan Knight
 */
@Internal
@SuppressWarnings("serial")
public class DelegatingProperties extends Properties
{
    /**
     * The default {@link Properties} to use when it's not possible to determine
     * {@link ContainerScope} for {@link Properties}.
     */
    private Properties m_defaultProperties;


    /**
     * Constructs a {@link DelegatingProperties}
     *
     * @param properties  the default {@link Properties}
     */
    public DelegatingProperties(Properties properties)
    {
        m_defaultProperties = properties;
    }


    /**
     * Obtains the {@link Properties} on which to delegate calls.
     *
     * @return  the {@link Properties} delegate.
     */
    private Properties getDelegate()
    {
        ContainerScope scope = Container.getContainerScope();

        return scope == null ? m_defaultProperties : scope.getProperties();
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public Object setProperty(String key,
                              String value)
    {
        return getDelegate().setProperty(key, value);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void load(Reader reader) throws IOException
    {
        getDelegate().load(reader);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void load(InputStream inStream) throws IOException
    {
        getDelegate().load(inStream);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void store(Writer writer,
                      String comments) throws IOException
    {
        getDelegate().store(writer, comments);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void store(OutputStream out,
                      String       comments) throws IOException
    {
        getDelegate().store(out, comments);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void loadFromXML(InputStream in) throws IOException
    {
        getDelegate().loadFromXML(in);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void storeToXML(OutputStream os,
                           String       comment) throws IOException
    {
        getDelegate().storeToXML(os, comment);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void storeToXML(OutputStream os,
                           String       comment,
                           String       encoding) throws IOException
    {
        getDelegate().storeToXML(os, comment, encoding);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public String getProperty(String key)
    {
        return getDelegate().getProperty(key);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public String getProperty(String key,
                              String defaultValue)
    {
        return getDelegate().getProperty(key, defaultValue);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public Enumeration propertyNames()
    {
        return getDelegate().propertyNames();
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public Set stringPropertyNames()
    {
        return getDelegate().stringPropertyNames();
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void list(PrintStream out)
    {
        getDelegate().list(out);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void list(PrintWriter out)
    {
        getDelegate().list(out);
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public int size()
    {
        return getDelegate().size();
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isEmpty()
    {
        return getDelegate().isEmpty();
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public Enumeration