step.core.accessors.AbstractOrganizableObject Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (C) 2020, exense GmbH
 *  
 * This file is part of STEP
 *  
 * STEP is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *  
 * STEP is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *  
 * You should have received a copy of the GNU Affero General Public License
 * along with STEP.  If not, see .
 ******************************************************************************/
package step.core.accessors;

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

/**
 * This class extends {@link AbstractIdentifiableObject} and is used
 * as parent class for all the objects that should be organized or identified 
 * by custom attributes
 *
 */
public class AbstractOrganizableObject extends AbstractIdentifiableObject {
	
	protected Map attributes;
	
	public static final String NAME = "name";
	public static final String VERSION = "version";
	
	public AbstractOrganizableObject() {
		super();
	}

	/**
	 * @return the attributes that identify this object's instance
	 */
	public Map getAttributes() {
		return attributes;
	}

	/**
	 * Sets the attributes used to identify this object's instance
	 * 
	 * @param attributes the object's attributes as key-value pairs
	 */
	public void setAttributes(Map attributes) {
		this.attributes = attributes;
	}
	
	/**
	 * Add an attribute to the attribute. This will initialize the map if it is null
	 * This method is not thread safe
	 * 
	 * @param key the name of the attribute
	 * @param value the value
	 */
	public void addAttribute(String key, String value) {
		if(attributes==null) {
			attributes = new HashMap<>();
		}
		attributes.put(key, value);
	}

	public boolean hasAttribute(String key) {
		if(attributes != null) {
			return attributes.containsKey(key);
		} else {
			return false;
		}
	}
	
	public String getAttribute(String key) {
		if(attributes != null) {
			return attributes.get(key);
		} else {
			return null;
		}
	}
}