KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > deployers > spi > structure > vfs > StructuredDeployers


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 JavaDoc;
25
26 import org.jboss.deployers.spi.DeploymentException;
27 import org.jboss.virtual.VirtualFile;
28
29 /**
30  * An encapsulation of the avaialble StructureDeployer
31  *
32  * @author Scott.Stark@jboss.org
33  * @version $Revision:$
34  */
35 public interface StructuredDeployers
36 {
37    /**
38     *
39     * @param file - root of the deployment in the VFS
40     * @param metaData - the existing metadata to use/populate with structure metadata
41     * @return true if the deployment was recognized, false if it was not
42     * @throws DeploymentException - thrown on failure to parse the deployment
43     */
44    public boolean determineStructure(VirtualFile file, StructureMetaData metaData)
45       throws DeploymentException;
46
47    /**
48     * Get the ordered set of deployers.
49     * @return the ordered set of deployers.
50     */
51    public SortedSet JavaDoc<StructureDeployer> getDeployers();
52    /**
53     * Are there any deployers
54     * @return
55     */
56    public boolean isEmpty();
57 }
58
Popular Tags