com.redhat.victims.fingerprint.Artifact Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of victims-lib Show documentation
A java library providing fingerprinting and service interaction for the Victims Project.
There is a newer version: 1.3.6
package com.redhat.victims.fingerprint;

/*
 * #%L
 * This file is part of victims-lib.
 * %%
 * Copyright (C) 2013 The Victims Project
 * %%
 * This program 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.
 * 
 * This program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 * #L%
 */

import java.util.ArrayList;
import java.util.HashMap;

import com.redhat.victims.fingerprint.Fingerprint;
import com.redhat.victims.fingerprint.Metadata;

/**
 * The main container for a hash map data structure used to store victims record
 * information.
 * 
 * @author abn
 * 
 */
@SuppressWarnings("serial")
public class Artifact extends HashMap {
	/**
	 * Maintains a list of value types that can be added to the record.
	 */
	protected static final ArrayList> PERMITTED_VALUE_TYPES = new ArrayList>();
	static {
		PERMITTED_VALUE_TYPES.add(Artifact.class);
		PERMITTED_VALUE_TYPES.add(String.class);
		PERMITTED_VALUE_TYPES.add(ArrayList.class);
		PERMITTED_VALUE_TYPES.add(Fingerprint.class);
		PERMITTED_VALUE_TYPES.add(Metadata.class);
		PERMITTED_VALUE_TYPES.add(HashMap.class);
	};

	public Artifact() {
		super();
	}

	@Override
	public Object put(Key key, Object value) throws IllegalArgumentException {
		if (!PERMITTED_VALUE_TYPES.contains(value.getClass())) {
			throw new IllegalArgumentException(String.format(
					"Values of class type <%s> are not permitted in <%s>",
					value.getClass().getName(), this.getClass().getName()));
		}
		return super.put(key, value);
	}

	private String getString(Key key) {
		Object value = get(key);
		if (value != null) {
			return (String) value;
		}
		return null;
	}

	public String filename() {
		return getString(Key.FILENAME);
	}

	public String filetype() {
		return getString(Key.FILETYPE);

	}

	@SuppressWarnings("unchecked")
	public ArrayList contents() {
		Object value = get(Key.CONTENT);
		if (value != null) {
			return (ArrayList) value;
		}
		return null;
	}

	@SuppressWarnings("unchecked")
	public ArrayList embedded() {
		Object value = get(Key.EMBEDDED);
		if (value != null) {
			return (ArrayList) value;
		}
		return null;
	}

	@SuppressWarnings("unchecked")
	public HashMap metadata() {
		Object value = get(Key.METADATA);
		if (value != null) {
			return (HashMap) value;
		}
		return null;
	}

	public Fingerprint fingerprint() {
		Object value = get(Key.FINGERPRINT);
		if (value != null) {
			return (Fingerprint) value;
		}
		return null;
	}

	public Fingerprint contentOnlyFingerprint() {
		Object value = get(Key.CONTENT_FINGERPRINT);
		if (value != null) {
			return (Fingerprint) value;
		}
		return null;
	}
}