org.vafer.jdeb.debian

Class ControlFile

java.lang.Object

org.vafer.jdeb.debian.ControlFile

Direct Known Subclasses:

BinaryPackageControlFile, ChangesFile

public abstract class ControlFile
extends Object

A control file as specified by the Debian policy.

Author:

Torsten Curdt

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<ControlField>	userDefinedFieldNames
protected Map<String,String>	userDefinedFields
protected Map<String,String>	values

Constructor Summary

Constructors

Constructor and Description
ControlFile()

Method Summary

Methods

Modifier and Type	Method and Description
String	get(String field)
protected abstract ControlField[]	getFields()
List<String>	getMandatoryFields()
protected abstract char	getUserDefinedFieldLetter() Returns the letter expected in the prefix of a user defined field in order to include the field in this control file.
protected String	getUserDefinedFieldName(String field) Returns the user defined field without its prefix.
protected Set<ControlField>	getUserDefinedFieldNames()
protected Map<String,String>	getUserDefinedFields()
Set<String>	invalidFields()
protected boolean	isUserDefinedField(String field) Tells if the specified field name is a user defined field.
boolean	isValid()
void	parse(InputStream input)
void	parse(String input)
void	set(String field, String value)
String	toString()
String	toString(ControlField... fields)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

values

protected final Map<String,String> values

userDefinedFields

protected final Map<String,String> userDefinedFields

userDefinedFieldNames

protected final Set<ControlField> userDefinedFieldNames

Constructor Detail

ControlFile

public ControlFile()

Method Detail

parse

public void parse(String input)
           throws IOException,
                  ParseException

Throws:

IOException

ParseException

parse

public void parse(InputStream input)
           throws IOException,
                  ParseException

Throws:

IOException

ParseException

set

public void set(String field,
       String value)

get

public String get(String field)

getFields

protected abstract ControlField[] getFields()

getUserDefinedFields

protected Map<String,String> getUserDefinedFields()

getUserDefinedFieldNames

protected Set<ControlField> getUserDefinedFieldNames()

getMandatoryFields

public List<String> getMandatoryFields()

isValid

public boolean isValid()

invalidFields

public Set<String> invalidFields()

toString

public String toString(ControlField... fields)

toString

public String toString()

Overrides:

toString in class Object

getUserDefinedFieldLetter

protected abstract char getUserDefinedFieldLetter()

Returns the letter expected in the prefix of a user defined field in order to include the field in this control file.

Returns:

The letter returned is:

• B: for a binary package
• S: for a source package
• C: for a changes file

Since:

1.1

See Also:

Debian Policy - User-defined fields

isUserDefinedField

protected boolean isUserDefinedField(String field)

Tells if the specified field name is a user defined field. User-defined fields must begin with an 'X', followed by one or more letters that specify the output file and a hyphen.

Parameters:

field - the name of the field

Since:

1.1

See Also:

Debian Policy - User-defined fields

getUserDefinedFieldName

protected String getUserDefinedFieldName(String field)

Returns the user defined field without its prefix.

Parameters:

field - the name of the user defined field

Returns:

the user defined field without the prefix, or null if the fields doesn't apply to this control file.

Since:

1.1