DocumentTitle.Holder (dcm4che-typeddicom-lib 0.3.1 API)

All Superinterfaces:: AttributesWrapper

All Known Subinterfaces:: EncapsulatedDocumentModule

All Known Implementing Classes:: EncapsulatedCDAIOD, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, PertinentDocumentsSequence.Item

Enclosing class:: DocumentTitle

public static interface DocumentTitle.Holder extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Document Title" (see DocumentTitle)

Method Summary

Modifier and Type

Method

Description

default boolean

containsDocumentTitle()

default DocumentTitle

getDocumentTitle()

default void

removeDocumentTitle()

Removes the Document Title (see DocumentTitle

static DocumentTitle.Holder

wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper
copy, getAttributes, isEmpty

Method Details
- wrap
  
  static DocumentTitle.Holder wrap(org.dcm4che3.data.Attributes attributes)
  
  Parameters:
  
  attributes - An attributes object containing the Document Title (see DocumentTitle)
  
  Returns:
  
  A wrapper object implementing the DocumentTitle.Holder interface.
- getDocumentTitle
  
  default DocumentTitle getDocumentTitle()
  
  Returns:
  
  the Document Title (see DocumentTitle)
- containsDocumentTitle
  
  default boolean containsDocumentTitle()
  
  Returns:
  
  Whether it contains the Document Title (see DocumentTitle)
- removeDocumentTitle
  
  default void removeDocumentTitle()
  
  Removes the Document Title (see DocumentTitle