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

com.hazelcast.config.MapAttributeConfig Maven / Gradle / Ivy

There is a newer version: 62
Show newest version
/*
 * Copyright (c) 2008-2019, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed 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 com.hazelcast.config;

import com.hazelcast.nio.ObjectDataInput;
import com.hazelcast.nio.ObjectDataOutput;
import com.hazelcast.nio.serialization.IdentifiedDataSerializable;
import com.hazelcast.query.QueryConstants;

import java.io.IOException;
import java.util.regex.Pattern;

import static com.hazelcast.util.Preconditions.checkHasText;
import static java.lang.String.format;

/**
 * Contains the configuration of a custom attribute that will be extracted from a Map's entry using a given ValueExtractor.
 * This class should be used in combination with the {@link MapConfig}.
 *
 * @see com.hazelcast.query.extractor.ValueExtractor
 */
public class MapAttributeConfig implements IdentifiedDataSerializable {

    private static final Pattern NAME_PATTERN = Pattern.compile("^[a-zA-Z0-9][a-zA-Z0-9_]*$");

    private String name;
    private String extractor;

    private transient MapAttributeConfigReadOnly readOnly;

    /**
     * Creates an empty MapAttributeConfig.
     */
    public MapAttributeConfig() {
    }

    /**
     * Creates a MapAttributeConfig with the given attribute and ordered setting.
     * 

* Name may begin with an ascii letter [A-Za-z] or digit [0-9] and may contain ascii letters [A-Za-z], digits [0-9] * or underscores later on. * * @param name the name given to an attribute that is going to be extracted * @param extractor full class name of the extractor used to extract the value of the attribute * @see #setName(String) * @see #setExtractor(String) */ public MapAttributeConfig(String name, String extractor) { setName(name); setExtractor(extractor); } public MapAttributeConfig(MapAttributeConfig config) { name = config.getName(); extractor = config.getExtractor(); } /** * Gets immutable version of this configuration. * * @return immutable version of this configuration * @deprecated this method will be removed in 4.0; it is meant for internal usage only */ public MapAttributeConfigReadOnly getAsReadOnly() { if (readOnly == null) { readOnly = new MapAttributeConfigReadOnly(this); } return readOnly; } /** * Gets the name of the attribute extracted by the extractor. * * @return the name of the attribute extracted by the extractor * @see #setName(String) */ public String getName() { return name; } /** * Sets the name of the attribute extracted by the extractor. * The name cannot be equal to any of the query constants. * * @param name the name of the attribute extracted by the extractor * @return the updated MapAttributeConfig * @throws IllegalArgumentException if attribute is null,an empty or inappropriate string * @see QueryConstants */ public MapAttributeConfig setName(String name) { this.name = checkName(name); return this; } private static String checkName(String name) { checkHasText(name, "Map attribute name must contain text"); checkNameValid(name); checkNotQueryConstant(name); return name; } private static void checkNameValid(String name) { if (!NAME_PATTERN.matcher(name).matches()) { throw new IllegalArgumentException("Map attribute name is invalid. It may contain upper-case and lower-case" + " letters, digits and underscores but an underscore may not be located at the first position)."); } } private static void checkNotQueryConstant(String name) { for (QueryConstants constant : QueryConstants.values()) { if (name.equals(constant.value())) { throw new IllegalArgumentException(format("Map attribute name must not contain query constant '%s'", constant.value())); } } } /** * Gets the full class name of the extractor in a String format, e.g. {@code com.example.car.SpeedExtractor}. * * @return the full class name of the extractor in a String format * @see #setExtractor(String) */ public String getExtractor() { return extractor; } /** * Sets the full class name of the extractor in a String format, e.g. {@code com.example.car.SpeedExtractor}. * * @param extractor the full class name of the extractor in a String format * @return the updated MapAttributeConfig */ public MapAttributeConfig setExtractor(String extractor) { this.extractor = checkHasText(extractor, "Map attribute extractor must contain text"); return this; } @Override public String toString() { return "MapAttributeConfig{" + "name='" + name + '\'' + "extractor='" + extractor + '\'' + '}'; } @Override public int getFactoryId() { return ConfigDataSerializerHook.F_ID; } @Override public int getId() { return ConfigDataSerializerHook.MAP_ATTRIBUTE_CONFIG; } @Override public void writeData(ObjectDataOutput out) throws IOException { out.writeUTF(name); out.writeUTF(extractor); } @Override public void readData(ObjectDataInput in) throws IOException { name = in.readUTF(); extractor = in.readUTF(); } @Override public boolean equals(Object o) { if (this == o) { return true; } if (o == null || getClass() != o.getClass()) { return false; } MapAttributeConfig that = (MapAttributeConfig) o; if (name != null ? !name.equals(that.name) : that.name != null) { return false; } return extractor != null ? extractor.equals(that.extractor) : that.extractor == null; } @Override public int hashCode() { int result = name != null ? name.hashCode() : 0; result = 31 * result + (extractor != null ? extractor.hashCode() : 0); return result; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy