Package net.webpdf.wsclient.openapi

Class OperationTextExtractionLinks

java.lang.Object

net.webpdf.wsclient.openapi.OperationTextExtractionLinks

public class OperationTextExtractionLinks
extends Object

OperationTextExtractionLinks

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_FROM_TEXT
static String	JSON_PROPERTY_PROTOCOL
static String	JSON_PROPERTY_WITHOUT_PROTOCOL

Constructor Summary

Constructors

Constructor	Description
OperationTextExtractionLinks()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
OperationTextExtractionLinks	fromText(Boolean fromText)
@Nullable Boolean	getFromText()	Advanced mode for extracting links When using this mode, links will not be extracted from annotations, but will instead be extracted directly from the text.
@Nullable String	getProtocol()	Provides the option of filtering the links being extracted by protocol.
@Nullable Boolean	getWithoutProtocol()	When enabled, incomplete URLs from which the protocol information is missing will be extracted as well when extracting links from text.
int	hashCode()
OperationTextExtractionLinks	protocol(String protocol)
void	setFromText(Boolean fromText)
void	setProtocol(String protocol)
void	setWithoutProtocol(Boolean withoutProtocol)
String	toString()
OperationTextExtractionLinks	withoutProtocol(Boolean withoutProtocol)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_FROM_TEXT

public static final String JSON_PROPERTY_FROM_TEXT

See Also:

Constant Field Values

JSON_PROPERTY_PROTOCOL

public static final String JSON_PROPERTY_PROTOCOL

See Also:

Constant Field Values

JSON_PROPERTY_WITHOUT_PROTOCOL

public static final String JSON_PROPERTY_WITHOUT_PROTOCOL

See Also:

Constant Field Values

Constructor Detail

OperationTextExtractionLinks

public OperationTextExtractionLinks()

Method Detail

fromText

public OperationTextExtractionLinks fromText(Boolean fromText)

getFromText

@Nullable
public @Nullable Boolean getFromText()

Advanced mode for extracting links When using this mode, links will not be extracted from annotations, but will instead be extracted directly from the text. This means that links that are not found in standard mode can be found with this advanced mode, provided that they are present in the form of text.

Returns:

fromText

setFromText

public void setFromText(Boolean fromText)

protocol

public OperationTextExtractionLinks protocol(String protocol)

getProtocol

@Nullable
public @Nullable String getProtocol()

Provides the option of filtering the links being extracted by protocol. If multiple protocols are specified, they need to be separated with commas (e.g., \"http,https,ftp\"). The following values are valid: \"http\",\"https\",\"ftp\", \"telnet\",\"mailto\", \"file\", \"nntp\", and \"notes\".

Returns:

protocol

setProtocol

public void setProtocol(String protocol)

withoutProtocol

public OperationTextExtractionLinks withoutProtocol(Boolean withoutProtocol)

getWithoutProtocol

@Nullable
public @Nullable Boolean getWithoutProtocol()

When enabled, incomplete URLs from which the protocol information is missing will be extracted as well when extracting links from text. This would apply to the following examples, for instance: * \"www.webpdf.de\" - There is no protocol information. If the option is enabled and \"http\" links are searched for, the link will be extracted. * \"ftp.softvision.de\" - There is no protocol information here either. If the option is enabled and \"ftp\" links are searched for, the link will be extracted.

Returns:

withoutProtocol

setWithoutProtocol

public void setWithoutProtocol(Boolean withoutProtocol)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object