org.jrimum.bopepo.pdf.PdfDocInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bpp-cobranca Show documentation
Show all versions of bpp-cobranca Show documentation
This is a fork and merge from JRimum ( http://www.jrimum.org ),
- Bopepo: https://github.com/jrimum/bopepo
- Texgit: https://github.com/jrimum/texgit
- Valia: https://github.com/jrimum/vallia
- Utilix: https://github.com/jrimum/utilix
- Domkee: https://github.com/jrimum/domkee
For Brazillian Boleto Payment Method. So much thanks for original authors:
Gilmar P. S. L, Misael Barreto and Rômulo Augusto.
The newest version!
/*
* Copyright 2011 JRimum Project
*
* 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.
*
* Created at: 19/09/2011 - 15:43:26
*
* ================================================================================
*
* Direitos autorais 2011 JRimum Project
*
* Licenciado sob a Licença Apache, Versão 2.0 ("LICENÇA"); você não pode usar
* esse arquivo exceto em conformidade com a esta LICENÇA. Você pode obter uma
* cópia desta LICENÇA em http://www.apache.org/licenses/LICENSE-2.0 A menos que
* haja exigência legal ou acordo por escrito, a distribuição de software sob
* esta LICENÇA se dará “COMO ESTÁ”, SEM GARANTIAS OU CONDIÇÕES DE QUALQUER
* TIPO, sejam expressas ou tácitas. Veja a LICENÇA para a redação específica a
* reger permissões e limitações sob esta LICENÇA.
*
* Criado em: 19/09/2011 - 15:43:26
*
*/
package org.jrimum.bopepo.pdf;
import com.itextpdf.text.pdf.PdfDate;
import static org.jrimum.utilix.Objects.checkNotNull;
import static org.jrimum.utilix.Objects.isNotNull;
import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;
import org.jrimum.utilix.Exceptions;
import org.jrimum.utilix.Objects;
/**
* Pricipais informações de um documento PDF: Título, Autor, Assunto,
* Palavras-chave, Aplicativo criador, Data de criação e Data de
* modificação
* .
*
* @author Gilmar P.S.L.
*
*/
public class PdfDocInfo {
/*
* Mesmas chaves de pesquisa usadas pelo itext.
*/
/**
* Key = Título do documento.
*/
private static final String DOC_TITLE = "Title";
/**
* Key = Autor do documento.
*/
private static final String DOC_AUTHOR = "Author";
/**
* Key = Assunto do documento.
*/
private static final String DOC_SUBJECT = "Subject";
/**
* Key = Palavras-chave do documento.
*/
private static final String DOC_KEYWORDS = "Keywords";
/**
* Key = Ferramenta/Software usada para do documento.
*/
private static final String DOC_CREATOR = "Creator";
/**
* Key = Data de criação do documento.
*/
private static final String DOC_CREATION_DATE = "CreationDate";
/**
* Key = Data de modificação do documento.
*/
private static final String DOC_MODIFACTION_DATE = "ModDate";
/**
* Key = Ferramenta/Software que de fato produziu o documento.
*/
private static final String DOC_PRODUCER = "Producer";
/**
* Map com informações sobre o documento: Title, Author, Subject, etc.
*/
private final Map docInfo;
/**
* Modo de criação não utilizado e não permitido.
*/
private PdfDocInfo() {
Exceptions.throwIllegalStateException("Estado não permitido!");
docInfo = null;
}
/**
* Apenas para uso interno.
*
* @param info
*/
private PdfDocInfo(Map info) {
checkNotNull(info);
this.docInfo = info;
}
/**
* Cria uma nova instância sem informações.
*
* @return referência prota para uso
*/
public static PdfDocInfo create() {
return new PdfDocInfo(new HashMap(8));
}
/**
* Cria uma nova instância com as informações fornecidas.
*
* @param info Informações sobre um documento
*
* @return referência prota para uso
*/
public static PdfDocInfo create(Map info) {
checkNotNull(info, "INFO INVÁLIDA!");
return new PdfDocInfo(info);
}
/**
* Define o Título do documento.
*
* @param title
*
* @return Esta instância após a operação
*/
public PdfDocInfo title(String title) {
if (isNotNull(title)) {
docInfo.put(DOC_TITLE, title);
}
return this;
}
/**
* Define o Autor do documento.
*
* @param author
*
* @return Esta instância após a operação
*/
public PdfDocInfo author(String author) {
if (isNotNull(author)) {
docInfo.put(DOC_AUTHOR, author);
}
return this;
}
/**
* Define o Assunto do documento.
*
* @param subject
*
* @return Esta instância após a operação
*/
public PdfDocInfo subject(String subject) {
if (isNotNull(subject)) {
docInfo.put(DOC_SUBJECT, subject);
}
return this;
}
/**
* Define as Palavras-chave do documento.
*
* @param keywords
*
* @return Esta instância após a operação
*/
public PdfDocInfo keywords(String keywords) {
if (isNotNull(keywords)) {
docInfo.put(DOC_KEYWORDS, keywords);
}
return this;
}
/**
* Define o Software/Ferramenta de criação do documento.
*
* @param creator
*
* @return Esta instância após a operação
*/
public PdfDocInfo creator(String creator) {
if (isNotNull(creator)) {
docInfo.put(DOC_CREATOR, creator);
}
return this;
}
/**
* Define a Data de criação do documento.
*
* @param date Data de criação
*
* @return Esta instância após a operação
*
* @throws IllegalArgumentException quando a date é nula
*/
public PdfDocInfo creation(Calendar date) {
Objects.checkNotNull(date, "Valor null não permitido para data de criação do documento!");
docInfo.put(DOC_CREATION_DATE, PdfDateConverter.convert(date));
return this;
}
/**
* Define a Data de modificação do documento.
*
* @param date Data de modificação
*
* @return Esta instância após a operação
*
* @throws IllegalArgumentException quando a date é nula
*/
public PdfDocInfo modification(Calendar date) {
Objects.checkNotNull(date, "Valor null não permitido para data de modificação do documento!");
Objects.checkNotNull(date);
docInfo.put(DOC_MODIFACTION_DATE, PdfDateConverter.convert(date));
return this;
}
/**
* @return Título do documento
*/
public String title() {
return docInfo.get(DOC_TITLE);
}
/**
* @return Autor do documento
*/
public String author() {
return docInfo.get(DOC_AUTHOR);
}
/**
* @return Assunto do documento
*/
public String subject() {
return docInfo.get(DOC_SUBJECT);
}
/**
* @return Palavras-chave do documento
*/
public String keywords() {
return docInfo.get(DOC_KEYWORDS);
}
/**
* @return Criador do documento
*/
public String creator() {
return docInfo.get(DOC_CREATOR);
}
/**
* Data de criação do documento em string, provalvelmento no seguinte
* formato: (D:YYYYMMDDHHmmSSOHH'mm').
*
* @return Data de criação do documento
*/
public String creationRaw() {
return docInfo.get(DOC_CREATION_DATE);
}
/**
* @return Data de criação do documento
*/
public Calendar creation() {
return PdfDate.decode(docInfo.get(DOC_CREATION_DATE));
}
/**
* Data de modificação do documento em string, provalvelmento no seguinte
* formato: (D:YYYYMMDDHHmmSSOHH'mm').
*
* @return Data de modificação do documento
*/
public String modificationRaw() {
return docInfo.get(DOC_MODIFACTION_DATE);
}
/**
* @return Data de modificação do documento
*/
public Calendar modification() {
return PdfDate.decode(docInfo.get(DOC_MODIFACTION_DATE));
}
/**
* Retorna a descrição do produtor do documento.
*
*
* Obs: "You can’t change this without breaking the software license that
* allows you to use iText for free."
*
*
* @return Descrição do produtor
*/
public String producer() {
return docInfo.get(DOC_PRODUCER);
}
/**
* Transforma as informações do documento em um novo Map a cada chamada.
*
* @return Map de informações
*/
public Map toMap() {
return new HashMap(docInfo);
}
/**
* Geração a partir do {@code hashCode()} do {@linkplain #docInfo}.
*
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((docInfo == null) ? 0 : docInfo.hashCode());
return result;
}
/**
* Comparação com base no {@linkplain #docInfo}.
*
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
PdfDocInfo other = (PdfDocInfo) obj;
if (docInfo == null) {
if (other.docInfo != null) {
return false;
}
} else if (!docInfo.equals(other.docInfo)) {
return false;
}
return true;
}
/**
* Informação contida em {@linkplain #docInfo}.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return "PdfDocInfo [docInfo=" + docInfo + "]";
}
}