001    /*
002     * The MIT License
003     * Copyright (c) 2012 Microsoft Corporation
004     *
005     * Permission is hereby granted, free of charge, to any person obtaining a copy
006     * of this software and associated documentation files (the "Software"), to deal
007     * in the Software without restriction, including without limitation the rights
008     * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
009     * copies of the Software, and to permit persons to whom the Software is
010     * furnished to do so, subject to the following conditions:
011     *
012     * The above copyright notice and this permission notice shall be included in
013     * all copies or substantial portions of the Software.
014     *
015     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
016     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
017     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
018     * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
019     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
020     * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
021     * THE SOFTWARE.
022     */
023    
024    package microsoft.exchange.webservices.data.core.response;
025    
026    import microsoft.exchange.webservices.data.core.EwsServiceXmlReader;
027    import microsoft.exchange.webservices.data.core.XmlElementNames;
028    import microsoft.exchange.webservices.data.core.enumeration.misc.XmlNamespace;
029    import microsoft.exchange.webservices.data.property.complex.EmailAddress;
030    
031    import java.util.ArrayList;
032    import java.util.Collection;
033    
034    /**
035     * Represents the response to a GetRooms operation.
036     */
037    public final class GetRoomsResponse extends ServiceResponse {
038    
039      /**
040       * The rooms.
041       */
042      private Collection<EmailAddress> rooms = new ArrayList<EmailAddress>();
043    
044      /**
045       * Initializes a new instance of the class.
046       */
047      public GetRoomsResponse() {
048        super();
049      }
050    
051      /**
052       * Gets collection for all rooms returned.
053       *
054       * @return the rooms
055       */
056      public Collection<EmailAddress> getRooms() {
057        return this.rooms;
058      }
059    
060      /**
061       * Reads response elements from XML.
062       *
063       * @param reader the reader
064       * @throws Exception the exception
065       */
066      @Override
067      protected void readElementsFromXml(EwsServiceXmlReader reader)
068          throws Exception {
069        this.rooms.clear();
070        super.readElementsFromXml(reader);
071    
072        reader.readStartElement(XmlNamespace.Messages, XmlElementNames.Rooms);
073    
074        if (!reader.isEmptyElement()) {
075          // Because we don't have an element for count of returned object,
076          // we have to test the element to determine if it is StartElement of
077          // return object or EndElement
078          reader.read();
079          while (reader.isStartElement(XmlNamespace.Types,
080              XmlElementNames.Room)) {
081            reader.read(); // skip the start <Room>
082    
083            EmailAddress emailAddress = new EmailAddress();
084            emailAddress.loadFromXml(reader, XmlElementNames.RoomId);
085            this.rooms.add(emailAddress);
086    
087            reader.readEndElement(XmlNamespace.Types, XmlElementNames.Room);
088            reader.read();
089          }
090    
091          reader.ensureCurrentNodeIsEndElement(XmlNamespace.Messages,
092              XmlElementNames.Rooms);
093        } else {
094          reader.read();
095        }
096      }
097    }