Index
All Classes|All Packages|Constant Field Values|Deprecated API|Serialized Form
G
- generate() - Method in interface org.nekosoft.pdffer.template.PdfTemplate
-
Prepares the PDF document.
- generate() - Method in class org.nekosoft.PDFferTemplates.DefaultPdfTemplate
- generate() - Method in class org.nekosoft.PDFferTemplates.invoice.PdfInvoiceTemplate
- generateBeanName(BeanDefinition, BeanDefinitionRegistry) - Method in class org.nekosoft.pdffer.registry.PdfferTemplateBeanNameGenerator
- generatePdfDocument(String, Object) - Method in class org.nekosoft.pdffer.PdfferProducerBean
-
Generates a new PDF with the given template (that must be present in the root registry) and the given payload.
- generatePdfDocument(String, String, T) - Method in class org.nekosoft.pdffer.PdfferProducerBean
-
Generates a new PDF with a template by the given name and group and with the given payload.
- generatePdfDocumentByPath(String, Object) - Method in class org.nekosoft.pdffer.PdfferProducerBean
-
Generates a new PDF with the template at the given template path and with the given payload.
- generatePdfDocumentByPathFromJsonMap(String, Map<String, Object>) - Method in class org.nekosoft.pdffer.PdfferProducerBean
-
Generates a new PDF with the template at the given template path and with the given payload.
- generatePdfDocumentByPathFromJsonString(String, String) - Method in class org.nekosoft.pdffer.PdfferProducerBean
-
Generates a new PDF with a template at the given path and with the given payload.
- generatePdfDocumentFromJsonMap(String, String, Map<String, Object>) - Method in class org.nekosoft.pdffer.PdfferProducerBean
-
Generates a new PDF with a template by the given name and group and with the given payload.
- generatePdfDocumentFromJsonMap(String, Map<String, Object>) - Method in class org.nekosoft.pdffer.PdfferProducerBean
-
Generates a new PDF with the given template (that must be present in the root registry) and the given payload.
- generatePdfDocumentFromJsonString(String, String) - Method in class org.nekosoft.pdffer.PdfferProducerBean
-
Generates a new PDF with the given template (that must be present in the root registry) and the given payload.
- generatePdfDocumentFromJsonString(String, String, String) - Method in class org.nekosoft.pdffer.PdfferProducerBean
-
Generates a new PDF with a template by the given name and group and with the given payload.
- getActualPayloadClass() - Method in exception org.nekosoft.pdffer.exception.InvalidPayloadClassException
-
Gets the class of the payload instance the producer was given.
- getActualTemplateClass() - Method in exception org.nekosoft.pdffer.exception.InvalidTemplateClassException
-
Gets the actual class of the template being used.
- getAddress() - Method in class org.nekosoft.pdffer.props.EmailAddressInfo
-
Gets the email address.
- getBankDetails() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the bank details.
- getBaseUri() - Method in class org.nekosoft.pdffer.props.PdfferMailerControllerProps
-
Gets the base URL of the controller.
- getBaseUri() - Method in class org.nekosoft.pdffer.props.PdfferWebControllerProps
-
Gets the base URL for the controller.
- getClient() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the client name.
- getClientAddress() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the client's address.
- getClientEmail() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the client's email.
- getClientTaxCode() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the client's tax code.
- getCurrency() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the invoice currency.
- getDescription() - Method in class org.nekosoft.PDFferTemplates.invoice.LineItemData
-
Gets the description.
- getDownloadUri() - Method in class org.nekosoft.pdffer.props.PdfferWebControllerProps
-
Gets the URL for the download endpoint of the controller.
- getDueDate() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the due date of the invoice.
- getEmailTo() - Method in class org.nekosoft.pdffer.web.EmailRequestData
-
Gets the email address to send the PDF to.
- getExpectedPayloadClass() - Method in exception org.nekosoft.pdffer.exception.InvalidPayloadClassException
-
Gets the payload class expected by the PDF template.
- getExpectedTemplateClass() - Method in exception org.nekosoft.pdffer.exception.InvalidTemplateClassException
-
Gets the expected superclass of templates that can be used.
- getFilename() - Method in class org.nekosoft.pdffer.web.DownloadRequestData
-
Gets the name of the file for the PDF to be downloaded.
- getFilename() - Method in class org.nekosoft.pdffer.web.EmailRequestData
-
Gets the filename that will be used for the attachment.
- getFooter1() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the first line of the footer.
- getFooter2() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the second line of the footer.
- getGroup() - Method in exception org.nekosoft.pdffer.exception.TemplateGroupNotFoundException
-
Gets the group name that could not be found.
- getGroup() - Method in exception org.nekosoft.pdffer.exception.TemplateNotFoundException
-
Gets the group name for the template that could not be found.
- getHost() - Method in class org.nekosoft.pdffer.props.SmtpServerInfo
-
Gets the host.
- getInvoiceDate() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the invoice date.
- getInvoiceNo() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the invoice number.
- getItemTotal() - Method in class org.nekosoft.PDFferTemplates.invoice.LineItemData
-
Calculates the item total.
- getJavaMailProperties() - Method in class org.nekosoft.pdffer.props.SmtpServerInfo
-
Gets extra options as a Java Properties instance.
- getJsonMapper() - Method in class org.nekosoft.pdffer.template.AbstractJacksonPdfTemplate
-
Returns the Jackson
ObjectMapper
that is used for converting payloads from JSON strings and Java maps to the payload type of the template. - getLineItems() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the line items.
- getMailUri() - Method in class org.nekosoft.pdffer.props.PdfferMailerControllerProps
-
Gets the URL for the mail endpoint of the controller.
- getMessage() - Method in class org.nekosoft.pdffer.web.EmailRequestData
-
Gets the main message of the email that will contain the PDF.
- getName() - Method in class org.nekosoft.pdffer.props.EmailAddressInfo
-
Gets the name of the owner of the address.
- getPassword() - Method in class org.nekosoft.pdffer.props.SmtpServerInfo
-
Gets the password.
- getPayload() - Method in exception org.nekosoft.pdffer.exception.InvalidPayloadException
-
Gets the payload that fails validation.
- getPayload() - Method in class org.nekosoft.pdffer.template.AbstractJacksonPdfTemplate
- getPayload() - Method in interface org.nekosoft.pdffer.template.PdfTemplate
-
Returns the payload used by this instance to generate a PDF document.
- getPayload() - Method in class org.nekosoft.pdffer.web.AbstractRequestData
-
The payload data that the PDF template will use to generate the PDF.
- getPayloadClass() - Method in interface org.nekosoft.pdffer.template.PdfTemplate
-
Returns the payload class that this template is able to handle.
- getPayloadClass() - Method in class org.nekosoft.PDFferTemplates.DefaultPdfTemplate
- getPayloadClass() - Method in class org.nekosoft.PDFferTemplates.invoice.PdfInvoiceTemplate
- getPayloadJson() - Method in exception org.nekosoft.pdffer.exception.PayloadFormatException
-
Returns the JSON string that caused the failure, or
null
if the failure was caused by a Java map - getPayloadMap() - Method in exception org.nekosoft.pdffer.exception.PayloadFormatException
-
Returns the map that caused the failure, or
null
if the failure was caused by a JSON string - getPayloadSource() - Method in exception org.nekosoft.pdffer.exception.PayloadFormatException
-
Returns the representation that caused the failure - it could be a JSON string or a Java map.
- getPdfContent() - Method in class org.nekosoft.pdffer.template.AbstractJacksonPdfTemplate
- getPdfContent() - Method in interface org.nekosoft.pdffer.template.PdfTemplate
-
Returns the PDF document that was generated by
PdfTemplate.generate()
as an array of bytes - getPort() - Method in class org.nekosoft.pdffer.props.SmtpServerInfo
-
Gets the port.
- getQuantity() - Method in class org.nekosoft.PDFferTemplates.invoice.LineItemData
-
Gets the quantity.
- getReplyTo() - Method in class org.nekosoft.pdffer.props.PdfferMailerProps
-
Gets the default email address that will be used as the reply-to header for the emails sent by PDFfer.
- getReplyTo() - Method in class org.nekosoft.pdffer.web.EmailRequestData
-
Gets the reply-to email address in full RFC 6854 format.
- getSaveUri() - Method in class org.nekosoft.pdffer.props.PdfferWebControllerProps
-
Gets the URL for the save endpoint of the controller.
- getSender() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the sender's name.
- getSenderAddress() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the sender's address.
- getSenderEmail() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the sender's email.
- getSenderTaxCode() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Gets the sender's tax code.
- getSendFrom() - Method in class org.nekosoft.pdffer.props.PdfferMailerProps
-
Gets the default email address that will be used as the sender for the emails sent by PDFfer.
- getSendFrom() - Method in class org.nekosoft.pdffer.web.EmailRequestData
-
Gets the send-from email address in full RFC 6854 format.
- getSmtp() - Method in class org.nekosoft.pdffer.props.PdfferMailerProps
-
Gets the settings of the SMTP server that will be used to send email messages from PDFfer.
- getSubject() - Method in class org.nekosoft.pdffer.web.EmailRequestData
-
Gets the subject of the email that will contain the PDF.
- getSubtotal() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Calculates the subtotal of the invoice.
- getTaxName() - Method in class org.nekosoft.PDFferTemplates.invoice.LineItemData
-
Gets the tax name.
- getTaxRate() - Method in class org.nekosoft.PDFferTemplates.invoice.LineItemData
-
Gets the tax rate.
- getTaxSubtotals() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Calculates the tax subtotals for each line item tax type.
- getTaxTotal() - Method in class org.nekosoft.PDFferTemplates.invoice.LineItemData
-
Calculates the tax total.
- getTemplateName() - Method in exception org.nekosoft.pdffer.exception.TemplateNotFoundException
-
Gets the template name that could not be found.
- getTemplatePath(String, String) - Static method in interface org.nekosoft.pdffer.template.PdfTemplate
-
Makes a template path string from group and name.
- getTemplatePath(PdfTemplate<?>) - Static method in interface org.nekosoft.pdffer.template.PdfTemplate
-
Returns the template path string for the given template.
- getTotal() - Method in class org.nekosoft.PDFferTemplates.invoice.InvoiceData
-
Calculates the total of the invoice.
- getUnitFormat() - Method in class org.nekosoft.PDFferTemplates.invoice.LineItemData
-
Gets the unit format.
- getUnitPrice() - Method in class org.nekosoft.PDFferTemplates.invoice.LineItemData
-
Gets the unit price.
- getUsername() - Method in class org.nekosoft.pdffer.props.SmtpServerInfo
-
Gets the username.
- group() - Element in annotation interface org.nekosoft.pdffer.template.PdfTemplateComponent
-
The group to which this template belongs.
- GROUP_SEPARATOR - Static variable in annotation interface org.nekosoft.pdffer.template.PdfTemplateComponent
-
The separator used for composing a template path from a name and group.
All Classes|All Packages|Constant Field Values|Deprecated API|Serialized Form