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