/*
* JBoss, Home of Professional Open Source
* Copyright 2006, JBoss Inc., and individual contributors as indicated
* 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.kernel.plugins.deployment.props.vertex;

import java.util.Comparator;

import org.jboss.kernel.plugins.deployment.props.TreeVertex;

/**
 * Level vertex factory.
 *
 * @author <a href="mailto:ales.justin@jboss.com">Ales Justin</a>
 */
public interface LevelVertexFactory
{
   /**
    * Create new vertex.
    * If name doesn't match factory's creation return null.
    *
    * @param name the name
    * @return new vertex instance or null if cannot create vertex from name
    */
   TreeVertex<?> createVertex(String name);

   /**
    * Get the order.
    *
    * @return the order
    */
   int getOrder();

   /**
    * LevelVertexFactory comparator.
    */
   public static Comparator<LevelVertexFactory> COMPARATOR = new LevelVertexFactoryComparator();

   static class LevelVertexFactoryComparator implements Comparator<LevelVertexFactory>
   {
      public int compare(LevelVertexFactory o1, LevelVertexFactory o2)
      {
         return o1.getOrder() - o2.getOrder();
      }
   }
}
