org.apache.felix.bundleplugin

Class ManifestWriter

java.lang.Object

org.apache.felix.bundleplugin.ManifestWriter

public class ManifestWriter
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static byte[]	CONTINUE Unfortunately we have to write our own manifest :-( because of a stupid bug in the manifest code.
(package private) static java.util.Set<java.lang.String>	NICE_HEADERS

Constructor Summary

Constructors

Constructor and Description
ManifestWriter()

Method Summary

Modifier and Type	Method and Description
private static void	attributes(java.util.jar.Attributes value, java.io.OutputStream out, boolean nice) Output an Attributes map.
static void	outputManifest(java.util.jar.Manifest manifest, java.io.OutputStream out, boolean nice) Main function to output a manifest properly in UTF-8.
private static int	write(java.io.OutputStream out, int width, byte[] bytes) Write the bytes but ensure that the line length does not exceed 72 characters.
private static int	write(java.io.OutputStream out, int i, java.lang.String s) Convert a string to bytes with UTF8 and then output in max 72 bytes
private static void	writeEntry(java.io.OutputStream out, java.lang.String name, java.lang.String value, boolean nice) Write out an entry, handling proper unicode and line length constraints

Methods inherited from class java.lang.Object

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

Field Detail

CONTINUE

static byte[] CONTINUE

Unfortunately we have to write our own manifest :-( because of a stupid bug in the manifest code. It tries to handle UTF-8 but the way it does it it makes the bytes platform dependent. So the following code outputs the manifest. A Manifest consists of

   'Manifest-Version: 1.0\r\n'
   main-attributes *
   \r\n
   name-section

   main-attributes ::= attributes
   attributes      ::= key ': ' value '\r\n'
   name-section    ::= 'Name: ' name '\r\n' attributes
 

Lines in the manifest should not exceed 72 bytes (! this is where the manifest screwed up as well when 16 bit unicodes were used).

As a bonus, we can now sort the manifest!

NICE_HEADERS

static java.util.Set<java.lang.String> NICE_HEADERS

Constructor Detail

ManifestWriter

public ManifestWriter()

Method Detail

outputManifest

public static void outputManifest(java.util.jar.Manifest manifest,
                                  java.io.OutputStream out,
                                  boolean nice)
                           throws java.io.IOException

Main function to output a manifest properly in UTF-8.

Parameters:

manifest - The manifest to output

out - The output stream

Throws:

java.io.IOException - when something fails

writeEntry

private static void writeEntry(java.io.OutputStream out,
                               java.lang.String name,
                               java.lang.String value,
                               boolean nice)
                        throws java.io.IOException

Write out an entry, handling proper unicode and line length constraints

Throws:

java.io.IOException

write

private static int write(java.io.OutputStream out,
                         int i,
                         java.lang.String s)
                  throws java.io.IOException

Convert a string to bytes with UTF8 and then output in max 72 bytes

Parameters:

out - the output string

i - the current width

s - the string to output

Returns:

the new width

Throws:

java.io.IOException - when something fails

write

private static int write(java.io.OutputStream out,
                         int width,
                         byte[] bytes)
                  throws java.io.IOException

Write the bytes but ensure that the line length does not exceed 72 characters. If it is more than 70 characters, we just put a cr/lf + space.

Parameters:

out - The output stream

width - The nr of characters output in a line before this method started

bytes - the bytes to output

Returns:

the nr of characters in the last line

Throws:

java.io.IOException - if something fails

attributes

private static void attributes(java.util.jar.Attributes value,
                               java.io.OutputStream out,
                               boolean nice)
                        throws java.io.IOException

Output an Attributes map. We will sort this map before outputing.

Parameters:

value - the attrbutes

out - the output stream

Throws:

java.io.IOException - when something fails