org.dihedron.crypto.constants.SignatureFormat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crypto Show documentation

Set of classes to support cryptography, including smart card detection, encryption, decription and signing.

The newest version!

/**
 * Copyright (c) 2012-2014, Andrea Funto'. All rights reserved.
 * 
 * This file is part of the Crypto library ("Crypto").
 *
 * Crypto is free software: you can redistribute it and/or modify it under 
 * the terms of the GNU Lesser General Public License as published by the Free 
 * Software Foundation, either version 3 of the License, or (at your option) 
 * any later version.
 *
 * Crypto 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 Lesser General Public License for more 
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License 
 * along with Crypto. If not, see .
 */
package org.dihedron.crypto.constants;


/** 
 * Signature types.
 * 
 *  @author Andrea Funto'
 */
public enum SignatureFormat {
	/** 
	 * PKCS#7 signature type (.p7m extension), with embedded data. 
	 */
	PKCS7_ATTACHED("cms-explicit"),
	
	/** 
	 * Detached PKCS#7 signature type (.p7m extension), no data. 
	 */
	PKCS7_DETACHED("cms-implicit"),
	
	/** 
	 * PDF signature type (.pdf extension), attached to the PDF. 
	 */
	PDF_ATTACHED("pdf-explicit"),
	
	/** 
	 * PDF signature type (.pdf extension), with no PDF data. 
	 */
	PDF_DETACHED("pdf-implicit");
	
	/**
	 * Tries to find a {@code SignatureFormat} value corresponding to the given
	 * textual description; the comparison is performed case insensitively.
	 * 
	 * @param description
	 *   a text description of the signature format, e.g. "cms-implicit".
	 * @return
	 *   an enumeration value, or null if none corresponds to the given description.
	 */
	public static SignatureFormat fromString(String description) {
		for (SignatureFormat format : SignatureFormat.values()) {
			if(format.getDescription().equalsIgnoreCase(description)) {
				return format;
			}
		}
		return null;
	}
		
	/**
	 * Returns the format as a descriptive string.
	 * 
	 * @return
	 *   the format as a descriptive string.
	 */
	public String getDescription() {
		return description;
	}
	
	/**
	 * Returns the format as a descriptive string.
	 * 
	 * @return
	 *   the format as a descriptive string.
	 */
	@Override
	public String toString() {
		return description;
	}
	
	/**
	 * Constructor.
	 * 
	 * @param description
	 */
	private SignatureFormat(String description) {
		this.description = description;
	}
	
	/**
	 * The format as a descriptive string.
	 */
	private String description;
}