/**
    * Licensed to jclouds, Inc. (jclouds) under one or more
    * contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  jclouds 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.jclouds.aws.ec2.xml;
  
  import static org.jclouds.util.SaxUtils.currentOrNull;
  import static org.jclouds.util.SaxUtils.equalsOrSuffix;
  
  import java.util.Set;
  
  import javax.inject.Inject;
  
  import org.jclouds.aws.ec2.domain.AWSRunningInstance;
  import org.jclouds.date.DateService;
  import org.jclouds.ec2.domain.Reservation;
  import org.jclouds.ec2.domain.RunningInstance;
  import org.jclouds.location.Region;
  import org.xml.sax.Attributes;
  import org.xml.sax.SAXException;
  
  import com.google.common.collect.Sets;
  import com.google.inject.Provider;
  
  /**
   * Parses the following XML document:
   * <p/>
   * DescribeImagesResponse xmlns="http:
   * 
   * @author Adrian Cole
   * @see <a href="http: />
   */
  public class AWSDescribeInstancesResponseHandler extends
        BaseAWSReservationHandler<Set<Reservation<? extends RunningInstance>>> {
     private Set<Reservation<? extends RunningInstance>> reservations = Sets.newLinkedHashSet();
     private boolean inTagSet;
     private String key;
     private String value;
  
     @Inject
     AWSDescribeInstancesResponseHandler(DateService dateService, @Region String defaultRegion,
           Provider<AWSRunningInstance.Builder> builderProvider, TagSetHandler tagSetHandler) {
        super(dateService, defaultRegion, builderProvider);
     }
  
     @Override
     public void startElement(String uri, String localName, String qName, Attributes attrs) throws SAXException {
        super.startElement(uri, localName, qName, attrs);
        if (equalsOrSuffix(qName, "tagSet")) {
           inTagSet = true;
        }
     }
  
     @Override
     public void endElement(String uri, String name, String qName) {
        if (equalsOrSuffix(qName, "tagSet")) {
           inTagSet = false;
        } else if (inTagSet) {
           if (equalsOrSuffix(qName, "key")) {
              key = currentOrNull(currentText);
           } else if (equalsOrSuffix(qName, "value")) {
              value = currentOrNull(currentText);
           }
        }
        super.endElement(uri, name, qName);
     }
  
     @Override
     public Set<Reservation<? extends RunningInstance>> getResult() {
        return reservations;
     }
  
     protected boolean endOfReservationItem() {
        return itemDepth == 1;
     }
  
     @Override
     protected void inItem() {
        if (endOfReservationItem()) {
           reservations.add(super.newReservation());
        } else if (inTagSet) {
           builder.tag(key, value);
           key = null;
           value = null;
        } else {
          super.inItem();
       }
    }
 
    protected boolean endOfInstanceItem() {
       return itemDepth == 2 && inInstancesSet;
    }
 }