org.apache.abdera.util.Configuration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  The ASF licenses this file to You
 * under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.  For additional information regarding
 * copyright in this work, please see the NOTICE file in the top level
 * directory of this distribution.
 */
package org.apache.abdera.util;

import java.io.Serializable;
import java.util.List;
import java.util.Map;
import org.apache.abdera.Abdera;
import org.apache.abdera.factory.ExtensionFactory;
import org.apache.abdera.factory.Factory;
import org.apache.abdera.parser.NamedParser;
import org.apache.abdera.parser.Parser;
import org.apache.abdera.parser.ParserFactory;
import org.apache.abdera.writer.NamedWriter;
import org.apache.abdera.writer.StreamWriter;
import org.apache.abdera.writer.Writer;
import org.apache.abdera.writer.WriterFactory;
import org.apache.abdera.xpath.XPath;

// @deprecated This API is deprecated as Apache Abdera is a retired project since 2017.
@Deprecated(since = "2021-07-29")
public interface Configuration extends Cloneable, Serializable {

    /**
     * Retrieve the value of the specified configuration option
     *
     * @return The configuration option value or null
     */
    public abstract String getConfigurationOption(String id);

    /**
     * Retrieve the value of the specified configuration option or _default if the value is null
     *
     * @return The configuration option value of _default
     */
    public abstract String getConfigurationOption(String id, String _default);

    /**
     * Get a new instance of the default Factory impl
     */
    public Factory newFactoryInstance(Abdera abdera);

    /**
     * Get a new instance of the default Parser impl
     */
    public Parser newParserInstance(Abdera abdera);

    /**
     * Get a new instance of the default XPath impl
     */
    public XPath newXPathInstance(Abdera abdera);

    /**
     * Get a new instance of the default ParserFactory impl
     */
    public ParserFactory newParserFactoryInstance(Abdera abdera);

    /**
     * Get a new instance of the default WriterFactory impl
     */
    public WriterFactory newWriterFactoryInstance(Abdera abdera);

    /**
     * Get a new instance of the default Writer impl
     */
    public Writer newWriterInstance(Abdera abdera);

    /**
     * Get a new instance of the default StreamWriter impl
     */
    public StreamWriter newStreamWriterInstance(Abdera abdera);

    /**
     * Get the collection of NamedParsers;
     */
    public Map getNamedParsers();

    /**
     * Get the collection of NamedWriters
     */
    public Map getNamedWriters();

    /**
     * Get the collection of Named StreamWriters
     */
    public Map> getStreamWriters();

    /**
     * Get the collection of ExtensionFactory impls
     */
    public List getExtensionFactories();

    public abstract Object clone();

    /**
     * Registers a new NamedParser, this method doesn't override a parser if already exists.
     *
     * @param parser is the new NamedParser to add
     * @return the instance of the configuration class
     */
    public Configuration addNamedParser(NamedParser parser);

    /**
     * Registers a new NamedWriter, this method doesn't override a writer if already exists.
     *
     * @param writer is the new NamedWriter to add
     * @return the instance of the configuration class
     */
    public Configuration addNamedWriter(NamedWriter writer);

    /**
     * Registers a new ExtensionFactory, this method doesn't override an extensionFactory if already exists.
     *
     * @param factory is the new ExtensionFactory to add
     * @return the instance of the configuration class
     */
    public Configuration addExtensionFactory(ExtensionFactory factory);

    /**
     * Registers a new StreamWriter, this method doesn't override a streamWriter if already exists.
     *
     * @param sw is the new StreamWriter to add
     * @return the instance of the configuration class
     */
    public Configuration addStreamWriter(Class sw);
}