org.plumelib.util

Class EntryReader.Entry

java.lang.Object

org.plumelib.util.EntryReader.Entry

Enclosing class:

EntryReader

public static class EntryReader.Entry
extends java.lang.Object

Descriptor for an entry (record, paragraph, etc.).

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	body Complete body of the entry including the first line.
java.lang.String	filename Filename in which the entry was found.
java.lang.String	firstLine First line of the entry.
long	lineNumber Line number of first line of entry.
boolean	shortEntry True if this is a short entry (blank-line-separated).

Constructor Summary

Constructors

Constructor and Description
Entry(java.lang.String firstLine, java.lang.String body, java.lang.String filename, long lineNumber, boolean shortEntry) Create an entry.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription(@Nullable java.util.regex.Pattern re) Return a substring of the entry body that matches the specified regular expression.

Methods inherited from class java.lang.Object

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

Field Detail

firstLine

public final java.lang.String firstLine

First line of the entry.

body

public final java.lang.String body

Complete body of the entry including the first line.

shortEntry

public final boolean shortEntry

True if this is a short entry (blank-line-separated).

filename

public final java.lang.String filename

Filename in which the entry was found.

lineNumber

public final long lineNumber

Line number of first line of entry.

Constructor Detail

Entry

public Entry(java.lang.String firstLine,
             java.lang.String body,
             java.lang.String filename,
             long lineNumber,
             boolean shortEntry)

Create an entry.

Parameters:

firstLine - first line of the entry

body - complete body of the entry including the first line

shortEntry - true if this is a short entry (blank-line-separated)

filename - filename in which the entry was found

lineNumber - line number of first line of entry

Method Detail

getDescription

public java.lang.String getDescription(@Nullable java.util.regex.Pattern re)

Return a substring of the entry body that matches the specified regular expression. If no match is found, returns the firstLine.

Parameters:

re - regex to match

Returns:

a substring that matches re