com.mindoo.domino.jna.html.IHtmlConversionResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domino-jna Show documentation

Java project to access the HCL Domino C API using Java Native Access (JNA)

There is a newer version: 0.9.53

package com.mindoo.domino.jna.html;

import java.util.List;

/**
 * Container for a richtext-HTML conversion result, returning the HTML source code and information
 * about contained references to external targets (e.g. links / images)
 * 
 * @author Karsten Lehmann
 */
public interface IHtmlConversionResult {

	/**
	 * Returns the HTML code of the conversion result
	 * 
	 * @return html
	 */
	public String getText();
	
	/**
	 * Method to access all external references located in the HTML code (e.g. links or img tags)
	 * 
	 * @return references
	 */
	public List getReferences();
	
	/**
	 * Convenience method that calls {@link #getReferences()} and extracts the relevant
	 * data for all embedded img tags
	 * 
	 * @return embedded images
	 */
	public List getImages();

}