Module com.github.librepdf.openpdf

Package com.lowagie.text.xml.xmp

Class XmpWriter

java.lang.Object

com.lowagie.text.xml.xmp.XmpWriter

All Implemented Interfaces:

AutoCloseable

public class XmpWriter
extends Object
implements AutoCloseable

With this class you can create an Xmp Stream that can be used for adding Metadata to a PDF Dictionary. Remark that this class doesn't cover the complete XMP specification.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	about	The about string that goes into the rdf:Description tags.
protected char	end	The end attribute.
protected int	extraSpace	You can add some extra space in the XMP packet; 1 unit in this variable represents 100 spaces and a newline.
static String	EXTRASPACE	String used to fill the extra space.
static String	UTF16	A possible charset for the XMP.
static String	UTF16BE	A possible charset for the XMP.
static String	UTF16LE	A possible charset for the XMP.
static String	UTF8	A possible charset for the XMP.
protected OutputStreamWriter	writer	The writer to which you can write bytes for the XMP stream.
static String	XPACKET_PI_BEGIN	Processing Instruction required at the start of an XMP stream
static String	XPACKET_PI_END_R	Processing Instruction required at the end of an XMP stream for XMP streams that are read only
static String	XPACKET_PI_END_W	Processing Instruction required at the end of an XMP stream for XMP streams that can be updated

Constructor Summary

Constructors

Constructor	Description
XmpWriter(OutputStream os)	Creates an XmpWriter.
XmpWriter(OutputStream os, PdfDictionary info, int PdfXConformance)
XmpWriter(OutputStream os, String utfEncoding, int extraSpace)	Creates an XmpWriter.
XmpWriter(OutputStream os, Map info)

Method Summary

Modifier and Type	Method	Description
void	addRdfDescription(XmpSchema s)	Adds an rdf:Description.
void	addRdfDescription(String xmlns, String content)	Adds an rdf:Description.
void	close()	Flushes and closes the XmpWriter.
void	setAbout(String about)
void	setReadOnly()	Sets the XMP to read-only

Methods inherited from class java.lang.Object

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

Field Detail

UTF8

public static final String UTF8

A possible charset for the XMP.

See Also:

Constant Field Values

UTF16

public static final String UTF16

A possible charset for the XMP.

See Also:

Constant Field Values

UTF16BE

public static final String UTF16BE

A possible charset for the XMP.

See Also:

Constant Field Values

UTF16LE

public static final String UTF16LE

A possible charset for the XMP.

See Also:

Constant Field Values

EXTRASPACE

public static final String EXTRASPACE

String used to fill the extra space.

See Also:

Constant Field Values

XPACKET_PI_BEGIN

public static final String XPACKET_PI_BEGIN

Processing Instruction required at the start of an XMP stream

Since:

iText 2.1.6

See Also:

Constant Field Values

XPACKET_PI_END_W

public static final String XPACKET_PI_END_W

Processing Instruction required at the end of an XMP stream for XMP streams that can be updated

Since:

iText 2.1.6

See Also:

Constant Field Values

XPACKET_PI_END_R

public static final String XPACKET_PI_END_R

Processing Instruction required at the end of an XMP stream for XMP streams that are read only

Since:

iText 2.1.6

See Also:

Constant Field Values

extraSpace

protected int extraSpace

You can add some extra space in the XMP packet; 1 unit in this variable represents 100 spaces and a newline.

writer

protected OutputStreamWriter writer

The writer to which you can write bytes for the XMP stream.

about

protected String about

The about string that goes into the rdf:Description tags.

end

protected char end

The end attribute.

Constructor Detail

XmpWriter

public XmpWriter(OutputStream os,
                 String utfEncoding,
                 int extraSpace)
          throws IOException

Creates an XmpWriter.

Parameters:

os - output stream

utfEncoding - utf encoding to be used

extraSpace - extra space

Throws:

IOException - on error

XmpWriter

public XmpWriter(OutputStream os)
          throws IOException

Creates an XmpWriter.

Parameters:

os - output stream

Throws:

IOException - on error

XmpWriter

public XmpWriter(OutputStream os,
                 PdfDictionary info,
                 int PdfXConformance)
          throws IOException

Parameters:

os - output stream

info - PdfDictionary

PdfXConformance - pdf conformance eg. values PdfWriter.PDFA1A, PdfWriter.PDFA1B

Throws:

IOException - on error

XmpWriter

public XmpWriter(OutputStream os,
                 Map info)
          throws IOException

Parameters:

os - output stream

info - map of info

Throws:

IOException - on error

Method Detail

setReadOnly

public void setReadOnly()

Sets the XMP to read-only

setAbout

public void setAbout(String about)

Parameters:

about - The about to set.

addRdfDescription

public void addRdfDescription(String xmlns,
                              String content)
                       throws IOException

Adds an rdf:Description.

Parameters:

xmlns - xml namespace

content - content

Throws:

IOException - on error

addRdfDescription

public void addRdfDescription(XmpSchema s)
                       throws IOException

Adds an rdf:Description.

Parameters:

s - xmp schema

Throws:

IOException - on error

close

public void close()
           throws IOException

Flushes and closes the XmpWriter.

Specified by:

close in interface AutoCloseable

Throws:

IOException - on error