org.bndly.schema.model.Annotatable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.bndly.common.schema.model Show documentation

The newest version!

package org.bndly.schema.model;

/*-
 * #%L
 * Schema Model
 * %%
 * Copyright (C) 2013 - 2020 Cybercon GmbH
 * %%
 * 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.
 * #L%
 */

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

/**
 *
 * @author cybercon <[email protected]>
 */
public class Annotatable {
	private Map annotations;
	
	public Map getAnnotations() {
		return annotations == null ? Collections.EMPTY_MAP : annotations;
	}
	
	public void annotate(String key, String value) {
		if (key == null) {
			throw new IllegalArgumentException("annotation key is not allowed to be null");
		}
		if (value == null) {
			throw new IllegalArgumentException("annotation value is not allowed to be null");
		}
		if (annotations != null) {
			if (annotations.containsKey(key)) {
				throw new IllegalArgumentException("annotation key is already in use: " + key);
			}
		} else {
			annotations = new HashMap<>();
		}
		annotations.put(key, value);
	}
}