org.eclipse.webdav.IContextFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.guvnor.eclipse.webdav

We build this plugin because eclipse no longer distributes it and Guvnor tools needs it.

There is a newer version: 7.48.0.Final

package org.eclipse.webdav;

import org.eclipse.webdav.internal.kernel.Context;

/**
 * Factory for constructing WebDAV contexts.
 * 
 * The context corresponds to the header portion of
 * a WebDAV request or response.
 * 

 * Note: This class/interface is part of an interim API that is still under 
 * development and expected to change significantly before reaching stability. 
 * It is being made available at this early stage to solicit feedback from pioneering 
 * adopters on the understanding that any code that uses this API will almost 
 * certainly be broken (repeatedly) as the API evolves.
 * 
 *
 * @see Context
 */
public interface IContextFactory {
    /**
     * Create a new empty context.
     *
     * @return the new empty Context.
     */
    public IContext newContext();

    /**
     * Creates a new context based on the given context.
     * 
     * The newly created context acts like an acetate layer
     * over the base context: any changes made to the new
     * context are confined to that layer and do not affect
     * the base context; but changes to the base context show
     * through to the new context unless masked by another
     * change made to the new context (c.f. properties).
     *
     * @param baseContext the default values for the new context.
     * @return the new wrapping Context.
     */
    public IContext newContext(IContext baseContext);
}