Package org.docx4j.model.bookmarks

Class BookmarksIntegrity

java.lang.Object

org.docx4j.model.bookmarks.BookmarksIntegrity

public class BookmarksIntegrity
extends Object

Perform certain bookmark integrity checks (ie check for duplicates, missing starts, ends), and optionally, write fixes in-place

Since:

6.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BookmarksIntegrity.BookmarksStatus

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	log
private Writer	writer

Constructor Summary

Constructors

Constructor	Description
BookmarksIntegrity()

Method Summary

Modifier and Type	Method	Description
BookmarksIntegrity.BookmarksStatus	check(List<Object> contents, boolean remediate)
BookmarksIntegrity.BookmarksStatus	check(MainDocumentPart documentPart, boolean remediate)
private CTBookmark	find(List<CTBookmark> starts, BigInteger id)
private CTMarkupRange	findEnds(List<CTMarkupRange> ends, BigInteger id)
private static int	getIndex(List list, Object deletion)
private List<Object>	inspectBookmarks(List<Object> paragraphs)
private static boolean	remove(List list, Object deletion)
void	setWriter(Writer writer)	To record (human readable) results
private void	write(String s)

Methods inherited from class java.lang.Object

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

Field Details

log

protected static org.slf4j.Logger log

writer

private Writer writer

Constructor Details

BookmarksIntegrity

public BookmarksIntegrity()

Method Details

setWriter

public void setWriter(Writer writer)

To record (human readable) results

Parameters:

writer -

check

public BookmarksIntegrity.BookmarksStatus check(MainDocumentPart documentPart,
 boolean remediate)
                                         throws Exception

Parameters:

documentPart -

remediate -

Returns:

Throws:

Exception

check

public BookmarksIntegrity.BookmarksStatus check(List<Object> contents,
 boolean remediate)
                                         throws IOException

Parameters:

paragraphs -

remediate -

Returns:

Throws:

IOException

Exception

remove

private static boolean remove(List list,
 Object deletion)

getIndex

private static int getIndex(List list,
 Object deletion)

inspectBookmarks

private List<Object> inspectBookmarks(List<Object> paragraphs)
                               throws IOException

Throws:

IOException

find

private CTBookmark find(List<CTBookmark> starts,
 BigInteger id)

findEnds

private CTMarkupRange findEnds(List<CTMarkupRange> ends,
 BigInteger id)

write

private void write(String s)
            throws IOException

Throws:

IOException