001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008-2010 Sun Microsystems, Inc.
025 *      Portions Copyright 2015 ForgeRock AS.
026 */
027
028package org.opends.guitools.controlpanel.ui.nodes;
029
030import javax.swing.tree.DefaultMutableTreeNode;
031
032/**
033 * Abstract class with some common methods for all the nodes in the
034 * 'Manage Schema' tree.
035 *
036 */
037public abstract class SchemaElementTreeNode extends DefaultMutableTreeNode
038{
039  private static final long serialVersionUID = 5832209952457633471L;
040  private String name;
041  private Object schemaElement;
042
043  /**
044   * Constructor of the node.
045   * @param name the name of the node.
046   * @param schemaElement the schema element (attribute definition, object class
047   * definition, etc.) associated with the node.
048   */
049  protected SchemaElementTreeNode(String name, Object schemaElement)
050  {
051    super(name);
052    this.name = name;
053    this.schemaElement = schemaElement;
054  }
055
056  /**
057   * Returns the name of the node.
058   * @return the name of the node.
059   */
060  public String getName()
061  {
062    return name;
063  }
064
065  /**
066   * Returns the schema element associated with the node.
067   * @return the schema element associated with the node.
068   */
069  public Object getSchemaElement()
070  {
071    return schemaElement;
072  }
073
074  /** {@inheritDoc} */
075  public boolean isRoot()
076  {
077    return false;
078  }
079
080  /** {@inheritDoc} */
081  public boolean isLeaf()
082  {
083    return true;
084  }
085}