StructureMetaData


1   /*
2    * JBoss, Home of Professional Open Source
3    * Copyright 2006, Red Hat Middleware LLC, and individual contributors
4    * by the @authors tag. See the copyright.txt in the distribution for a
5    * full listing of individual contributors.
6    *
7    * This is free software; you can redistribute it and/or modify it
8    * under the terms of the GNU Lesser General Public License as
9    * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22  package org.jboss.deployers.spi.structure.vfs;
23  
24  import java.util.SortedSet  ;
25  
26  /**
27   * A map of vfs paths to deployment context information.
28   * 
29   * @author Scott.Stark@jboss.org
30   * @version $Revision:$
31   */
32  public interface StructureMetaData
33  {
34     /**
35      * Add a deployment context info. The context must have a vfs path, and its
36      * parent must already have been added if it has not been set on the context.
37      * 
38      * @param context - the context info
39      */
40     public void addContext(ContextInfo context);
41     /**
42      * Get a context based on its vfs path.
43      * @param vfsPath - the VFS path name
44      * @return the ContextInfo if one exists for vfsPath.
45      */
46     public ContextInfo getContext(String   vfsPath);
47     /**
48      * Remove a context based on its vfs path.
49      * @param vfsPath - the VFS path name
50      * @return the ContextInfo if one exists for vfsPath.
51      */
52     public ContextInfo removeContext(String   vfsPath);
53     /**
54      * Get the deployment context info ordered from parent to child. This must
55      * order parent contexts before their children.
56      * @return deployment context info ordered from parent to child.
57      */
58     public SortedSet  <ContextInfo> getContexts();
59  }
60
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags