propertydefinitioncategory.java

这是linux下ssl vpn的实现程序

/*
 *  SSL-Explorer
 *
 *  Copyright (C) 2003-2006 3SP LTD. All Rights Reserved
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2 of
 *  the License, or (at your option) any later version.
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public
 *  License along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
			
package com.sslexplorer.properties;

import java.util.Iterator;

/**
 * Property definitions may be categorised. Implementations of this interface
 * provide additional data about categories such as the bundle from which
 * to get resources and the path to use for images.
 * 
 * @author Brett Smith <a href="mailto: [e-mail]">&lt;[e-mail]&gt;</a>
 * @version $Revision: 1.2 $
 * @see com.sslexplorer.properties.PropertyDatabase
 */
public interface PropertyDefinitionCategory {
    
    /**
     * Get the ID for this property category
     * 
     * @return id
     */
    public int getId();
    
    /**
     * Get the key for the bundle containing message resources for this category
     * 
     * @return message bundle key
     */
    public String getBundle();
    
    /**
     * Get the page for the image for this category
     * 
     * @return image page
     */
    public String getImagePath();
    
    /**
     * Add a new child category to this category
     * 
     * @param category category to add
     * @return this category
     */
    public PropertyDefinitionCategory addCategory(PropertyDefinitionCategory category);

    /**
     * Remove a child category from this category
     * 
     * @param category category to remove
     * @return this category
     */

    public PropertyDefinitionCategory removeCategory(PropertyDefinitionCategory category);
    
    /**
     * Set the parent or <code>null</code> if at the root.
     * 
     * @param parent parent
     */
    public void setParent(PropertyDefinitionCategory parent);

    /**
     * Get the number of sub-categories
     *  
     * @return number of sub-categories
     */
    public int size();

    
    /**
     * Get an {@link Iterator} of all child categories
     * 
     * @return iterator of child categories
     */
    public Iterator categories();

    /**
     * Get if this category contains another
     * 
     * @param category category to test
     * @return <code>true</code> if this category contains the one specified 
     */
    public boolean contains(PropertyDefinitionCategory category);
}