/*
 * JBoss, Home of Professional Open Source
 * Copyright 2006, Red Hat Middleware LLC, and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.deployers.vfs.spi.structure;

import org.jboss.deployers.spi.DeploymentException;
import org.jboss.deployers.spi.Ordered;

/**
 * A StructureDeployer translates a deployment virtual file root into
 * StructureMetaData representing the deployment contexts.
 * 
 * @author <a href="adrian@jboss.com">Adrian Brock</a>
 * @version $Revision: 1.1 $
 */
public interface StructureDeployer extends Ordered
{
   /**
    * Determine the structure of a deployment
    * 
    * @param context the structure context
    * @return true when it recognised the context
    * @throws DeploymentException for an error
    */
   boolean determineStructure(StructureContext context) throws DeploymentException;

   /**
    * Do we support candidate annotations lookup.
    *
    * @return true if candidate annotaiotns lookup is supported, false otherwise
    */
   boolean isSupportsCandidateAnnotations();
}
