org.apache.myfaces.trinidad.component.ChildArrayList Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of trinidad-api Show documentation
Public API for the Apache MyFaces Trinidad project
There is a newer version: 2.2.1
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.myfaces.trinidad.component;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import java.util.Map;

import javax.faces.component.UIComponent;

import org.apache.myfaces.trinidad.logging.TrinidadLogger;


/**
 * List for storing children.
 *
 */
class ChildArrayList extends ArrayList
{
  public ChildArrayList(UIComponent parent)
  {
    _parent = parent;
  }

  @Override
  public void add(int index, UIComponent element)
  {
    if (element == null)
      throw new NullPointerException();

    if ((index < 0) || (index > size()))
      throw new IndexOutOfBoundsException(_LOG.getMessage(
        "INDEX_SIZE", new Object[]{index, size()}));

    UIComponent oldParent = element.getParent();
    if (oldParent != null)
    {
      int adjustedIndex = __removeFromParent(element, index);
      // Only adjust the index when the child is re-added to the same parent
      if (oldParent == _parent)
      {
        index = adjustedIndex; 
      }
    }
    
    // do not change the order of these calls, see TRINIDAD-1674 for more info
    super.add(index, element);
    element.setParent(_parent);
  }

  
  @Override
  public boolean add(UIComponent element)
  {
    add(size(), element);
    return true;
  }
  
  @Override
  public boolean addAll(Collection collection)
  {
    return addAll(size(), collection);
  }

  @Override
  public boolean addAll(
      int index, 
      Collection collection)
  {
    boolean changed = false;
    for(UIComponent element : collection)
    {
      if (element == null)
        throw new NullPointerException();

      add(index++, element);
      changed = true;
    }
    
    return changed;
  }

  @Override
  public UIComponent remove(int index)
  {
    UIComponent child = super.remove(index);
    child.setParent(null);

    return child;
  }

  @Override
  public boolean remove(Object element)
  {
    if (element == null)
      throw new NullPointerException();
    
    if (!(element instanceof UIComponent))
      return false;
  
    if (super.remove(element))
    {
      UIComponent child = (UIComponent) element;
      child.setParent(null);
      return true;
    }

    return false;
  }

  @Override
  public void clear()
  {
    int size = this.size();
    
    while ( size > 0)
    {
      size--;
      remove(size);
    }
    
    super.clear();
  }
  
  @Override
  public boolean removeAll(Collection collection)
  {
    boolean result = false;
    for (Object element : collection)
    {
      if (remove(element))
        result = true;
    }
    
    return result;
  }

  @Override
  public UIComponent set(int index, UIComponent element)
  {
    if (element == null)
      throw new NullPointerException();
    
    if ((index < 0) || (index >= size()))
      throw new IndexOutOfBoundsException();

    UIComponent child = element;
    UIComponent previous = get(index);

    previous.setParent(null);
    
    child.setParent(_parent);
    super.set(index, element);
    
    return previous;
  }

  @SuppressWarnings("unchecked")
  static int __removeFromParent(
    UIComponent component,
    int index)
  {
    UIComponent parent = component.getParent();
    assert(parent != null);

    if (parent.getChildCount() > 0)
    {
      List children = parent.getChildren();
      int size = children.size();
      for  (int i = 0; i < size; i++)
      {
        if  (children.get(i) == component)
        {
          children.remove(i);
          if (index > i)
            index--;
          return index;
        }
      }
    }
    
    // TRINIDAD-2369: Until TRINIDAD-2368 is fixed, we have to call remove() on the map
    // returned by getFacets() rather than calling remove() on getFacets().values()
    // Note that the old code used to call getFacets().values().contains(), which would iterate on the entry set.
    // The new code performs the same iteration, so it should not be any slower.
    
    Map facets = parent.getFacets();
    for (Map.Entry entry: facets.entrySet())
    {
      if (entry.getValue() == component)
      {
        facets.remove(entry.getKey());
        return index;
      }
    }

    // Not good - the child thought it was in a parent,
    // but it wasn't.
    assert(false);
    return index;
  }

  private final UIComponent _parent;
  private static final TrinidadLogger _LOG = TrinidadLogger.createTrinidadLogger(
    ChildArrayList.class);
  private static final long serialVersionUID = 1L;

}