com.featureprobe.sdk.server.FPUser Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of server-sdk-java Show documentation
FeatureProbe Server Side SDK for Java
There is a newer version: 2.3.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.featureprobe.sdk.server;

import java.util.HashMap;
import java.util.Map;

/**
 * A collection of attributes that can affect toggle evaluation, usually corresponding to a user of your application.
 */
public class FPUser {

    private String key;

    private Map attrs = new HashMap<>();

    /**
     * Creates a new FPUser
     */
    public FPUser() {
    }

    /**
     * Creates a new FPUser
     * @param key user unique id for percentage rollout
     */
    @Deprecated
    public FPUser(String key) {
        this.key = key;
    }

    /**
     * Set user unique id for percentage rollout
     * @param key user unique id for percentage rollout
     */
    public FPUser stableRollout(String key) {
        this.key = key;
        return this;
    }

    /**
     * Add an attribute to the user
     * @param name attribute name
     * @param value attribute value
     * @return the FPUser
     */
    public FPUser with(String name, String value) {
        attrs.put(name, value);
        return this;
    }

    /**
     * Check attribute exists
     * @param name attribute name
     * @return
     */
    public boolean containAttr(String name) {
        return attrs.containsKey(name);
    }

    /**
     * Get FPUser unique identifier
     * @return key
     */
    public String getKey() {
        if (key == null) {
            this.key = String.valueOf(System.nanoTime());
        }
        return key;
    }

    /**
     * Get FPUser all attribute
     * @return attribute set
     */
    public Map getAttrs() {
        return attrs;
    }

    /**
     * Add multiple attribute to the user
     * @param attrs attribute set
     */
    public void setAttrs(Map attrs) {
        this.attrs = attrs;
    }

    /**
     * Get the specified attribute value
     * @param name attribute name
     * @return attribute value
     */
    public String getAttr(String name) {
        return attrs.get(name);
    }

}