net.sourceforge.javadpkg.field.Field Maven / Gradle / Ivy

Go to download

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

The library for reading and writing Debian Packages.

There is a newer version: 1.0.5

/*
 * dpkg - Debian Package library and the Debian Package Maven plugin
 * (c) Copyright 2016 Gerrit Hohl
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * 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 General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package net.sourceforge.javadpkg.field;


/**
 * 
 * A field having a name and a value.
 * 
 * 
 * The name and value of empty fields are null. These fields
 * represents empty lines in the source / target.
 * 
 * 
 * The value can contain newlines.
 * 
 *
 * @author Gerrit Hohl ([email protected])
 * @version 1.0, 03.01.2016 by Gerrit Hohl
 */
public interface Field {
	
	
	/**
	 * 
	 * Returns the name.
	 * 
	 *
	 * @return The name or null, if the field is an empty field or
	 *         a nameless field.
	 * @see #isEmpty()
	 * @see #isNameless()
	 */
	String getName();
	
	
	/**
	 * 
	 * Returns the flag if the field has no name.
	 * 
	 * 
	 * An nameless field has no name, but a value.
	 * 
	 *
	 * @return The flag: true, if the field has no name,
	 *         false otherwise.
	 * @see #getName()
	 */
	boolean isNameless();
	
	
	/**
	 * 
	 * Returns the value.
	 * 
	 * 
	 * The value can contain newlines.
	 * 
	 *
	 * @return The value or null, if the field is an empty field.
	 * @see #isEmpty()
	 */
	String getValue();
	
	
	/**
	 * 
	 * Returns the value.
	 * 
	 * 
	 * The value can contain newlines. All "." lines are replaced by
	 * empty lines.
	 * 
	 * 
	 * @return The value or null, if the field is an empty field.
	 * @see #isEmpty()
	 */
	String getFormattedValue();
	
	
	/**
	 * 
	 * Returns the flag if the field is an empty field.
	 * 
	 * 
	 * An empty field has no name and no value.
	 * 
	 *
	 * @return The flag: true, if the field is an empty field.
	 * @see #getName()
	 * @see #getValue()
	 */
	boolean isEmpty();
	
	
}