/**

  * Copyright 2005-2011 The Kuali Foundation

  *

  * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php

  *

  * 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.kuali.rice.core.api.uif;

 import org.apache.commons.lang.StringUtils;

 import org.apache.commons.lang.builder.EqualsBuilder;

 import org.apache.commons.lang.builder.HashCodeBuilder;

 import org.apache.commons.lang.builder.ToStringBuilder;

 import org.kuali.rice.core.api.CoreConstants;

 import org.kuali.rice.core.api.mo.ModelBuilder;

 import org.kuali.rice.core.api.mo.ModelObjectComplete;

 import org.kuali.rice.core.api.util.jaxb.MapStringStringAdapter;

 import org.w3c.dom.Element;

 import javax.xml.bind.annotation.XmlAccessType;

 import javax.xml.bind.annotation.XmlAccessorType;

 import javax.xml.bind.annotation.XmlAnyElement;

 import javax.xml.bind.annotation.XmlElement;

 import javax.xml.bind.annotation.XmlRootElement;

 import javax.xml.bind.annotation.XmlType;

 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

 import java.util.Collection;

 import java.util.Collections;

 import java.util.HashMap;

 import java.util.Map;

 /**

  * A select control type.

  */

 @XmlRootElement(name = RemotableSelectGroup.Constants.ROOT_ELEMENT_NAME)

 @XmlAccessorType(XmlAccessType.NONE)

 @XmlType(name = RemotableSelectGroup.Constants.TYPE_NAME, propOrder = {

         RemotableSelectGroup.Elements.KEY_LABELS,

         RemotableSelectGroup.Elements.LABEL,

                 CoreConstants.CommonElements.FUTURE_ELEMENTS })

 public final class RemotableSelectGroup implements SelectGroup, ModelObjectComplete {

     @XmlElement(name = Elements.KEY_LABELS, required = true)

     @XmlJavaTypeAdapter(value = MapStringStringAdapter.class)

     private final Map<String, String> keyLabels;

     @XmlElement(name = Elements.LABEL, required = false)

     private final String label;

     @SuppressWarnings("unused")

     @XmlAnyElement

     private final Collection<Element> _futureElements = null;

     /**

      * Should only be invoked by JAXB.

      */

     @SuppressWarnings("unused")

     private RemotableSelectGroup() {

         label = null;

         keyLabels = null;

     }

     private RemotableSelectGroup(Builder b) {

         label = b.label;

         keyLabels = b.keyLabels;

     }

     @Override

     public Map<String, String> getKeyLabels() {

         return keyLabels;

     }

     @Override

     public String getLabel() {

         return label;

     }

     @Override

     public int hashCode() {

         return HashCodeBuilder.reflectionHashCode(this, Constants.HASH_CODE_EQUALS_EXCLUDE);

     }

     @Override

     public boolean equals(Object obj) {

         return EqualsBuilder.reflectionEquals(obj, this, Constants.HASH_CODE_EQUALS_EXCLUDE);

     }

     @Override

     public String toString() {

         return ToStringBuilder.reflectionToString(this);

     }

     public static final class Builder implements SelectGroup, ModelBuilder {

         private String label;

         private Map<String, String> keyLabels;

         private Builder(Map<String, String> keyLabels, String label) {

             setKeyLabels(keyLabels);

             setLabel(label);

         }

         public static Builder create(Map<String, String> keyLabels, String label) {

             return new Builder(keyLabels, label);

         }

         @Override

         public String getLabel() {

             return label;

         }

         public void setLabel(String label) {

             if (StringUtils.isBlank(label)) {

                 throw new IllegalArgumentException("label was blank");

             }

             this.label = label;

         }

         @Override

         public Map<String, String> getKeyLabels() {

             return keyLabels;

         }

         public void setKeyLabels(Map<String, String> keyLabels) {

             if (keyLabels == null || keyLabels.isEmpty()) {

                 throw new IllegalArgumentException("keyLabels must be non-null & non-empty");

             }

             this.keyLabels = Collections.unmodifiableMap(new HashMap<String, String>(keyLabels));

         }

         @Override

         public RemotableSelectGroup build() {

             return new RemotableSelectGroup(this);

         }

     }

     /**

      * Defines some internal constants used on this class.

      */

     static final class Constants {

         static final String TYPE_NAME = "SelectGroupType";

         final static String ROOT_ELEMENT_NAME = "selectGroup";

         final static String[] HASH_CODE_EQUALS_EXCLUDE = {CoreConstants.CommonElements.FUTURE_ELEMENTS};

     }

     static final class Elements {

         static final String LABEL = "label";

         static final String KEY_LABELS = "keyLabels";

     }

 }