All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.infinispan.commons.configuration.attributes.AttributeSet Maven / Gradle / Ivy

Go to download

Infinispan Commons

There is a newer version: 15.1.0.Dev04
Show newest version
package org.infinispan.commons.configuration.attributes;

import static org.infinispan.commons.logging.Log.CONFIG;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import org.infinispan.commons.configuration.Combine;
import org.infinispan.commons.configuration.io.ConfigurationWriter;
import org.infinispan.commons.util.TypedProperties;

/**
 * AttributeSet is a container for {@link Attribute}s. It is constructed by passing in a list of
 * {@link AttributeDefinition}s. AttributeSets are initially unprotected, which means that the contained attributes can
 * be modified. If the {@link #protect()} method is invoked then only attributes which are not
 * {@link AttributeDefinition#isImmutable()} can be modified from then on.
 *
 * @author Tristan Tarrant
 * @since 7.2
 */
public class AttributeSet implements AttributeListener, Matchable, Updatable {
   public static final AttributeSet EMPTY = new AttributeSet(null, "", null, new AttributeDefinition[0]).protect();
   private final Class klass;
   private final String name;
   private final Map> attributes;
   private boolean protect;

   private final Map removed;
   private boolean touched;

   public AttributeSet(Class klass, AttributeDefinition... attributeDefinitions) {
      this(klass, klass.getSimpleName(), null, attributeDefinitions);
   }

   public AttributeSet(String name, AttributeDefinition... attributeDefinitions) {
      this(name, null, attributeDefinitions);
   }

   public AttributeSet(Class klass, AttributeSet attributeSet, AttributeDefinition... attributeDefinitions) {
      this(klass, klass.getSimpleName(), attributeSet, attributeDefinitions);
   }

   public AttributeSet(String name, AttributeSet attributeSet, AttributeDefinition[] attributeDefinitions) {
      this(null, name, attributeSet, attributeDefinitions);
   }

   public AttributeSet(Class klass, Enum name, AttributeDefinition... attributeDefinitions) {
      this(klass, name.name(), null, attributeDefinitions);
   }

   public AttributeSet(Class klass, String name, AttributeSet attributeSet, AttributeDefinition[] attributeDefinitions) {
      this(klass, name, attributeSet, attributeDefinitions, null);
   }

   public AttributeSet(Class klass, String name, AttributeSet attributeSet, AttributeDefinition[] attributeDefinitions, RemovedAttribute[] removedAttributes) {
      this.klass = klass;
      this.name = name;
      Map> attributes;
      if (attributeSet != null) {
         attributes = new LinkedHashMap<>(attributeDefinitions.length + attributeSet.attributes.size());
         for (Attribute attribute : attributeSet.attributes.values()) {
            attributes.put(attribute.name(), attribute.getAttributeDefinition().toAttribute());
         }
      } else {
         attributes = new LinkedHashMap<>(attributeDefinitions.length);
      }
      for (AttributeDefinition def : attributeDefinitions) {
         if (attributes.containsKey(def.name())) {
            throw CONFIG.attributeSetDuplicateAttribute(def.name(), name);
         }
         Attribute attribute = (Attribute) def.toAttribute();
         if (!attribute.isImmutable())
            attribute.addListener(this);
         attributes.put(def.name(), attribute);
      }
      this.attributes = Collections.unmodifiableMap(attributes);
      if (removedAttributes == null) {
         this.removed = Collections.emptyMap();
      } else {
         var removed = new HashMap(removedAttributes.length);
         for (RemovedAttribute i : removedAttributes) {
            removed.put(i.name, i);
         }
         this.removed = Map.copyOf(removed);
      }
   }

   public Class getKlass() {
      return klass;
   }

   public String getName() {
      return name;
   }

   /**
    * Returns whether this attribute set contains the specified named attribute
    *
    * @param name the name of the attribute
    */
   public boolean contains(String name) {
      return attributes.containsKey(name);
   }

   /**
    * Returns whether this set contains the specified attribute definition
    *
    * @param def the {@link AttributeDefinition}
    */
   public  boolean contains(AttributeDefinition def) {
      return contains(def.name());
   }

   /**
    * Returns the named attribute
    *
    * @param name the name of the attribute to return
    * @return the attribute
    */
   @SuppressWarnings("unchecked")
   public  Attribute attribute(String name) {
      return (Attribute) this.attributes.get(name);
   }

   /**
    * Returns the named attribute
    *
    * @param name the name of the attribute to return
    * @return the attribute
    */
   public  Attribute attribute(Enum name) {
      return attribute(name.toString());
   }

   /**
    * Returns the attribute identified by the supplied {@link AttributeDefinition}
    *
    * @param def the attribute definition
    * @return the attribute
    */
   public  Attribute attribute(AttributeDefinition def) {
      Attribute attribute = attribute(def.name());
      if (attribute != null)
         return attribute;
      else
         throw CONFIG.noSuchAttribute(def.name(), name);
   }

   /**
    * Copies all attribute from another AttributeSet using the supplied {@link Combine.Attributes} strategy.
    *
    * @param other   the source AttributeSet
    * @param combine the attribute combine strategy
    */
   public void read(AttributeSet other, Combine combine) {
      for (Attribute attribute : attributes.values()) {
         if (attribute.getAttributeDefinition().isRepeated()) {
            Attribute a = other.attribute(attribute.name());
            if (a.isModified()) {
               if (combine.repeatedAttributes() == Combine.RepeatedAttributes.MERGE) {
                  ((Attribute) attribute).merge(a);
               } else {
                  ((Attribute) attribute).read(a);
               }
            }
         } else {
            if (combine.attributes() == Combine.Attributes.OVERRIDE) {
               attribute.reset();
            }
            Attribute a = other.attribute(attribute.name());
            if (a.isModified()) {
               ((Attribute) attribute).read(a);
            }
         }
      }
   }

   /**
    * Returns a new ValueSet where immutable {@link Attribute}s are write-protected
    *
    * @return
    */
   public AttributeSet protect() {
      AttributeDefinition[] attrDefs = new AttributeDefinition[attributes.size()];
      int i = 0;
      for (Attribute attribute : attributes.values()) {
         attrDefs[i++] = attribute.getAttributeDefinition();
      }
      AttributeSet protectedSet = new AttributeSet(klass, name, null, attrDefs);
      for (Attribute attribute : protectedSet.attributes.values()) {
         Attribute localAttr = this.attributes.get(attribute.name());
         attribute.read((Attribute) localAttr);
         attribute.protect();
      }
      protectedSet.protect = true;
      protectedSet.touched = this.touched;
      return protectedSet;
   }

   /**
    * Returns whether any attributes in this set have been modified
    */
   public boolean isModified() {
      for (Attribute attribute : attributes.values()) {
         if (attribute.isModified())
            return true;
      }
      return false;
   }

   /**
    * Returns whether this attribute set is protected
    */
   public boolean isProtected() {
      return protect;
   }

   /**
    * Writer a single attribute to the specified {@link ConfigurationWriter} using the attribute's xmlName
    *
    * @param writer the writer
    * @param def    the Attribute definition
    */
   public void write(ConfigurationWriter writer, AttributeDefinition def) {
      write(writer, def, def.name());
   }

   /**
    * Writer a single attribute to the specified {@link ConfigurationWriter} using the supplied name
    *
    * @param writer the writer
    * @param def    the Attribute definition
    * @param name   the XML tag name for the attribute
    */
   public void write(ConfigurationWriter writer, AttributeDefinition def, Enum name) {
      write(writer, def, name.toString());
   }

   /**
    * Writer a single attribute to the specified {@link ConfigurationWriter} using the supplied name
    *
    * @param writer the writer
    * @param def    the Attribute definition
    * @param name   the XML tag name for the attribute
    */
   public void write(ConfigurationWriter writer, AttributeDefinition def, String name) {
      Attribute attribute = attribute(def);
      attribute.write(writer, name);
   }


   /**
    * Writes this attributeset to the specified ConfigurationWriter as an element
    *
    * @param writer
    */
   public void write(ConfigurationWriter writer, String name) {
      if (isModified()) {
         writer.writeStartElement(name);
         write(writer);
         writer.writeEndElement();
      }
   }

   /**
    * Writes this attributeset to the specified ConfigurationWriter as an element
    *
    * @param writer
    */
   public void write(ConfigurationWriter writer, Enum name) {
      write(writer, name.toString());
   }

   /**
    * Writes the specified attributes in this attributeset to the specified ConfigurationWriter as an element
    *
    * @param writer the {@link ConfigurationWriter}
    * @param persistentName the name the attribute should have in its persistent form
    * @param defs the attributes that should be written
    */
   public void write(ConfigurationWriter writer, String persistentName, AttributeDefinition... defs) {
      if (Arrays.stream(defs).anyMatch(def -> attribute(def).isModified())) {
         writer.writeStartElement(persistentName);
         for (AttributeDefinition def : defs) {
            Attribute attr = attribute(def);
            attr.write(writer, attr.getAttributeDefinition().name());
         }
         writer.writeEndElement();
      }
   }

   /**
    * Writes the attributes of this attributeset as part of the current element
    *
    * @param writer
    */
   public void write(ConfigurationWriter writer) {
      List> deferred = new ArrayList<>();
      for (Attribute attr : attributes.values()) {
         if (attr.isPersistent()) {
            if (attr.getAttributeDefinition().serializer().defer()) {
               deferred.add(attr);
            } else {
               attr.write(writer, attr.getAttributeDefinition().name());
            }
         }
      }
      for(Attribute attr : deferred) {
         attr.write(writer, attr.getAttributeDefinition().name());
      }
   }

   /**
    * Validates the {@link Attribute} values.
    */
   public void validate() {
      attributes.values().forEach(Attribute::validate);
   }

   @Override
   public int hashCode() {
      final int prime = 31;
      int result = 1;
      result = prime * result + ((attributes == null) ? 0 : attributes.hashCode());
      return result;
   }

   @Override
   public boolean equals(Object obj) {
      if (this == obj)
         return true;
      if (obj == null)
         return false;
      if (getClass() != obj.getClass())
         return false;
      AttributeSet other = (AttributeSet) obj;
      if (attributes == null) {
         return other.attributes == null;
      } else return attributes.equals(other.attributes);
   }

   @Override
   public boolean matches(AttributeSet other) {
      if (other.attributes.size() != attributes.size())
         return false;
      for (Map.Entry> e : attributes.entrySet()) {
         String key = e.getKey();
         Attribute value = e.getValue();
         if (value == null) {
            if (!(other.attributes.containsKey(key) && other.attributes.get(key) == null))
               return false;
         } else {
            if (!value.matches(other.attributes.get(key)))
               return false;
         }
      }
      return true;
   }

   @Override
   public void update(String parentName, AttributeSet other) {
      for (Map.Entry> e : attributes.entrySet()) {
         e.getValue().update(parentName, other.attribute(e.getKey()));
      }
   }

   @Override
   public void validateUpdate(String parentName, AttributeSet other) {
      IllegalArgumentException iae = new IllegalArgumentException();
      for (Map.Entry> e : attributes.entrySet()) {
         try {
            e.getValue().validateUpdate(parentName, other.attribute(e.getKey()));
         } catch (Throwable t) {
            iae.addSuppressed(t);
         }
      }
      if (iae.getSuppressed().length > 0) {
         throw iae;
      }
   }

   @Override
   public String toString() {
      return toString(name);
   }

   public String toString(String name) {
      StringBuilder sb = new StringBuilder();
      if (name != null) {
         sb.append(name);
         sb.append(" = ");
      }
      sb.append("[");
      boolean comma = false;
      for (Attribute value : attributes.values()) {
         if (comma) {
            sb.append(", ");
         } else {
            comma = true;
         }
         sb.append(value.toString());
      }
      sb.append("]");
      return sb.toString();
   }

   public AttributeSet checkProtection() {
      if (!protect) {
         throw CONFIG.unprotectedAttributeSet(name);
      }
      return this;
   }

   public void reset() {
      if (protect) {
         throw CONFIG.protectedAttributeSet(name);
      }
      for (Attribute attribute : attributes.values()) {
         attribute.reset();
      }
   }

   @Override
   public void attributeChanged(Attribute attribute, Object oldValue) {
   }

   public Collection> attributes() {
      return attributes.values();
   }

   public boolean isEmpty() {
      return attributes.entrySet().stream().allMatch(attrs -> {
         Attribute attr = attrs.getValue();
         return attr.isNull() || !attr.isModified();
      });
   }

   public TypedProperties fromProperties(TypedProperties properties, String prefix) {
      for (Attribute attr : attributes.values()) {
         String name = prefix + attr.name();
         if (properties.containsKey(name)) {
            attr.fromString(properties.getProperty(name, true));
         }
      }
      return properties;
   }

   public boolean isRemoved(String name, int major, int minor) {
      RemovedAttribute r = removed.get(name);
      return r != null && (major < r.major || (major == r.major && minor < r.minor));
   }

   public void touch() {
      this.touched = true;
   }

   public boolean isTouched() {
      return touched;
   }

   public static final class RemovedAttribute {
      final String name;
      final int major;
      final int minor;

      public RemovedAttribute(Enum name, int major, int minor) {
         this(name.toString(), major, minor);
      }

      public RemovedAttribute(String name, int major, int minor) {
         this.name = name;
         this.major = major;
         this.minor = minor;
      }
   }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy