Package apps.util.issuereporter

Class IssueReport

java.lang.Object

jmri.beans.UnboundBean

jmri.beans.Bean

apps.util.issuereporter.IssueReport

All Implemented Interfaces:

BeanInterface, PropertyChangeFirer, PropertyChangeProvider

Direct Known Subclasses:

BugReport, EnhancementRequest

@API(status=INTERNAL,
     consumers="apps.util.issuereporter.*")
public abstract class IssueReport
extends Bean

Common code for the various types of problem reports.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	body
protected String	title
protected boolean	tooLong

Fields inherited from class jmri.beans.Bean

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
IssueReport(String title, String body)

Method Summary

Modifier and Type	Method	Description
List<File>	getAttachments()
String	getBody()
String	getIssueFooter()
String	getSimpleContext()	Get the simple context (JMRI version, Java version, and OS)
protected abstract void	prepare()	Prepare a report.
URI	submit(GitHubRepository repository)	Submit a report.

Methods inherited from class jmri.beans.Bean

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, isNotifyOnEDT, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class jmri.beans.UnboundBean

getIndexedProperty, getProperty, getPropertyNames, hasIndexedProperty, hasProperty, setIndexedProperty, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

title

protected String title

body

protected String body

tooLong

protected boolean tooLong

Constructor Details

IssueReport

IssueReport(String title,
 String body)

Method Details

submit

@Nonnull
public URI submit(GitHubRepository repository)
           throws URISyntaxException,
IOException,
IssueReport414Exception

Submit a report.

Parameters:

repository - the GitHub repository to submit to

Returns:

the URI to submit the report to

Throws:

URISyntaxException - if unable to create URI for issue

IOException - if unable to connect to GitHub

IssueReport414Exception - if report is too long

prepare

protected abstract void prepare()

Prepare a report.

getAttachments

@Nonnull
public List<File> getAttachments()

getSimpleContext

@Nonnull
public String getSimpleContext()

Get the simple context (JMRI version, Java version, and OS)

Returns:

the context

getIssueFooter

@Nonnull
public String getIssueFooter()

getBody

@Nonnull
public String getBody()