summaryrefslogtreecommitdiffstats
path: root/src/net/java/joglutils/msg/nodes/Group.java
blob: 05486ab693b6564c65a58993b5461d97d1afe02e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
 * Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
 * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 * 
 * You acknowledge that this software is not designed or intended for use
 * in the design, construction, operation or maintenance of any nuclear
 * facility.
 * 
 */

package net.java.joglutils.msg.nodes;

import java.util.*;

import net.java.joglutils.msg.actions.*;

/** A node which manages other Node instances. */

public class Group extends Node implements Iterable<Node> {
  private List<Node> children = new ArrayList<Node>();

  /** Append a child node to the list of children nodes this group node is managing. */
  public void addChild(Node child) {
    if (child == null)
      throw new IllegalArgumentException("child may not be null");
    children.add(child);
  }

  /** Adds a child so that it becomes the one with the given index. */
  public void insertChild(int index, Node child) {
    if (child == null)
      throw new IllegalArgumentException("child may not be null");
    children.add(index, child);
  }

  /** Returns the child node with the given index. */
  public Node getChild(int index) {
    return children.get(index);
  }

  /** Finds the index of given child within the group. Returns -1 if not found. */
  public int  findChild(Node node) {
    return children.indexOf(node);
  }

  /** Returns number of children. */
  public int  getNumChildren() {
    return children.size();
  }

  /** Removes the child with given index from the group.

     @throws IndexOutOfBoundsException if the index is less than 0 or
     greater than the number of children
  */
  public void removeChild(int index) throws IndexOutOfBoundsException {
    children.remove(index);
  }

  /** Removes the given child from the group. This is a convenience
      method equivalent to calling {@link #findChild findChild} and,
      if the node is found, passing the index to {@link #removeChild
      removeChild}.
  */
  public void removeChild(Node node) {
    int idx = findChild(node);
    if (idx >= 0)
      removeChild(idx);
  }

  /** Removes all children from this Group node. */
  public void removeAllChildren() {
    children.clear();
  }

  /** Replaces the child at the given index with the new child.

     @throws IndexOutOfBoundsException if the index is less than 0 or
     greater than the number of children
  */
  public void replaceChild(int index, Node newChild) throws IndexOutOfBoundsException {
    if (newChild == null)
      throw new IllegalArgumentException("child may not be null");
    removeChild(index);
    insertChild(index, newChild);
  }

  /** Replaces the old child with the new child. This is a convenience
      method. It will simply call {@link #findChild findChild} with
      oldChild as argument, and call replaceChild(int, SoNode*) if the
      child is found. */
  public void replaceChild(Node oldChild, Node newChild) {
    if (newChild == null)
      throw new IllegalArgumentException("child may not be null");
    int idx = findChild(oldChild);
    if (idx >= 0)
      replaceChild(idx, newChild);
  }

  /** Returns an Iterator over the nodes this Group contains. */
  public Iterator<Node> iterator() {
    return children.iterator();
  }

  public void doAction(Action action) {
    for (int i = 0; i < getNumChildren(); i++) {
      action.apply(getChild(i));
    }
  }
}