Package com.levigo.jadice.document.util

Interface PropertiesProvider

All Known Subinterfaces:

Attachment, Document, Folder, Item, MutableOutline<N>, MutableOutlineNode<N>, MutablePageSegment, Outline<N>, OutlineNode<N>, Page, PageSegment, PageSegmentSource, UIDocument<C>

All Known Implementing Classes:

AbstractCompositePageSegment, AbstractDocument, AbstractMutablePageSegment, AbstractPage, AbstractPageSegment, AfpLineModeReaderSettings, Annotation, AnnotationPageSegment, AnnotationProfile, ArrowAnnotation, BasicDocument, BasicPage, Bookmark, CalloutAnnotation, CompositePageSegment, ContentsCreatorPageSegment, DefaultOutline, DefaultOutlineNode, DynamicCompositePageSegment, EllipseAnnotation, HistoryAnnotation, ImageAnnotation, ImportParameters, InstructionAnnotation, IOCAReaderSettings, LazyStreamPageSegment, LineAnnotation, MODCAReaderSettings, ObjectAnnotation, PathAnnotation, Reader, ReaderParameters, RectangleAnnotation, ShapeBasedAnnotation, StampAnnotation, StampImageAnnotation, SwingUIDocument, TextAnnotation, TextHighlightAnnotation, XFDFAnnotation, XFDFCaretAnnotation, XFDFCircleAnnotation, XFDFFreeTextAnnotation, XFDFHighlightAnnotation, XFDFInkAnnotation, XFDFLineAnnotation, XFDFMarkupAnnotation, XFDFPlainFreeTextAnnotation, XFDFPolygonAnnotation, XFDFPolylineAnnotation, XFDFPopupAnnotation, XFDFSquareAnnotation, XFDFSquigglyAnnotation, XFDFStampAnnotation, XFDFStrikeOutAnnotation, XFDFTextAnnotation, XFDFTextMarkupAnnotation, XFDFUnderlineAnnotation

public interface PropertiesProvider

An interface to be implemented by classes providing a map of properties associated with the instances of those classes.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getProperties()	Return a map of user properties.

Method Detail

getProperties

Map<String,Object> getProperties()

Return a map of user properties. What to store and which keys to use is largely up to the user of classes implementing this interface, since those classes will generally be oblivious to the map's contents. There are no guarantees regarding the thread-safety of the returned map, unless otherwise specified by implementors.

Returns:

the map of user properties