package com.trendmicro.grid.acl.metadata;
   
   import javax.xml.bind.annotation.*;
   import java.util.*;
   
   import static com.trendmicro.grid.acl.metadata.Profile.isNull;
   
   /**
    * Defines the entry describing a single meta element.
   *
   * @author Juergen_Kellerer, 2010-04-21
   * @version 1.0
   */
  @XmlAccessorType(XmlAccessType.FIELD)
  @XmlAccessorOrder(value = XmlAccessOrder.UNDEFINED)
  @XmlType(name = "entry", namespace = ProfilesDocument.NS)
  public class ProfileEntry {
  
  	@XmlAttribute(required = true)
  	String metaName;
  
  	@XmlList
  	@XmlAttribute(name = "validType", required = true)
  	Set<DataType> validTypes = new LinkedHashSet<DataType>();
  
  	@XmlAttribute
  	boolean readonly;
  
  	@XmlElement
  	Set<String> requiredBy;
  
  	@XmlElement
  	Set<String> providedBy;
  
  	@XmlElement(name = "requiredRole")
  	Set<String> requiredRoles;
  
  	@XmlAttribute(required = true)
  	AccessLevel accessLevel = AccessLevel.PRIVATE;
  
  	@XmlElement
  	String description;
  
  	@XmlElement(name = "comment")
  	String[] comments;
  
  	/**
  	 * Creates a new profile entry when de-serializing from XML.
  	 */
  	public ProfileEntry() {
  	}
  
  	/**
  	 * Creates a new profile entry for the given Meta name.
  	 *
  	 * @param metaName   The name of the Meta element to create this entry on.
  	 * @param validTypes A collection of valid data types for the Meta value.
  	 */
  	public ProfileEntry(String metaName, DataType... validTypes) {
  		if (metaName == null || metaName.isEmpty() || isNull(validTypes))
  			throw new IllegalArgumentException("Name and validTypes may not be left empty");
  
  		this.metaName = metaName;
  		this.validTypes.addAll(Arrays.asList(validTypes));
  	}
  
  	public String getMetaName() {
  		return metaName;
  	}
  
  	/**
  	 * Is a builder-pattern method that sets the specified values and returns this instance.
  	 *
  	 * @param level		 the protection level to apply to the Meta element.
  	 * @param requiredBy	the IDs of the required components.
  	 * @param requiredRoles the roles required to access the element.
  	 * @return This instance.
  	 */
  	public ProfileEntry values(AccessLevel level, String requiredBy, String... requiredRoles) {
  		setAccessLevel(level);
  		setRequiredBy(requiredBy);
  		setRequiredRoles(requiredRoles);
  
  		return this;
  	}
  
  	public boolean isReadonly() {
  		return readonly;
  	}
  
  	public void setReadonly(boolean readonly) {
  		this.readonly = readonly;
  	}
  
  	public String getDescription() {
  		return description;
  	}
  
  	public void setDescription(String description) {
 		this.description = description;
 	}
 
 	public List<String> getComments() {
 		if (comments == null)
 			return Collections.emptyList();
 		return Arrays.asList(comments);
 	}
 
 	public void setComments(String... comments) {
 		this.comments = comments;
 	}
 
 	public AccessLevel getAccessLevel() {
 		return accessLevel;
 	}
 
 	public void setAccessLevel(AccessLevel accessLevel) {
 		this.accessLevel = accessLevel;
 	}
 
 	public Set<String> getRequiredRoles() {
 		return requiredRoles;
 	}
 
 	public void setRequiredRoles(String... requiredRoles) {
 		setRequiredRoles(isNull(requiredRoles) ? null : new LinkedHashSet<String>(Arrays.asList(requiredRoles)));
 	}
 
 	public void setRequiredRoles(Set<String> requiredRoles) {
 		this.requiredRoles = requiredRoles;
 	}
 
 	public Set<DataType> getValidTypes() {
 		return validTypes;
 	}
 
 	public void setValidTypes(DataType... validTypes) {
 		setValidTypes(isNull(validTypes) ? null : new LinkedHashSet<DataType>(Arrays.asList(validTypes)));
 	}
 
 	public void setValidTypes(Set<DataType> validTypes) {
 		if (validTypes == null)
 			this.validTypes.clear();
 		else
 			this.validTypes = validTypes;
 	}
 
 	public Set<String> getRequiredBy() {
 		return requiredBy;
 	}
 
 	public void setRequiredBy(String... requiredBy) {
 		setRequiredBy(isNull(requiredBy) ? null : new LinkedHashSet<String>(Arrays.asList(requiredBy)));
 	}
 
 	public void setRequiredBy(Set<String> requiredBy) {
 		this.requiredBy = requiredBy;
 	}
 
 	public Set<String> getProvidedBy() {
 		return providedBy;
 	}
 
 	public void setProvidedBy(String... providedBy) {
 		setProvidedBy(isNull(providedBy) ? null : new LinkedHashSet<String>(Arrays.asList(providedBy)));
 	}
 
 	public void setProvidedBy(Set<String> providedBy) {
 		this.providedBy = providedBy;
 	}
 
 	@Override
 	public boolean equals(Object o) {
 		if (this == o) return true;
 		if (!(o instanceof ProfileEntry)) return false;
 
 		ProfileEntry that = (ProfileEntry) o;
 
 		if (description != null ? !description.equals(that.description) : that.description != null) return false;
 		if (metaName != null ? !metaName.equals(that.metaName) : that.metaName != null) return false;
 		if (accessLevel != that.accessLevel) return false;
 		if (providedBy != null ? !providedBy.equals(that.providedBy) : that.providedBy != null) return false;
 		if (requiredBy != null ? !requiredBy.equals(that.requiredBy) : that.requiredBy != null) return false;
 		if (requiredRoles != null ? !requiredRoles.equals(that.requiredRoles) : that.requiredRoles != null)
 			return false;
 		if (validTypes != null ? !validTypes.equals(that.validTypes) : that.validTypes != null) return false;
 
 		return true;
 	}
 
 	@Override
 	public int hashCode() {
 		int result = metaName != null ? metaName.hashCode() : 0;
 		result = 31 * result + (requiredBy != null ? requiredBy.hashCode() : 0);
 		result = 31 * result + (providedBy != null ? providedBy.hashCode() : 0);
 		result = 31 * result + (validTypes != null ? validTypes.hashCode() : 0);
 		result = 31 * result + (requiredRoles != null ? requiredRoles.hashCode() : 0);
 		result = 31 * result + (accessLevel != null ? accessLevel.hashCode() : 0);
 		result = 31 * result + (description != null ? description.hashCode() : 0);
 		return result;
 	}
 
 	@Override
 	public String toString() {
 		return "ProfileEntry{" +
 			"metaName='" + metaName + '\'' +
 			", requiredBy=" + (requiredBy == null ? null : Arrays.asList(requiredBy)) +
 			", validTypes=" + (validTypes == null ? null : Arrays.asList(validTypes)) +
 			", requiredRoles=" + (requiredRoles == null ? null : Arrays.asList(requiredRoles)) +
 			", accessLevel=" + accessLevel +
 			", description='" + description + '\'' +
 			'}';
 	}
 }