Skip to content

Commit

Permalink
Normalize getter Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Oct 31, 2023
1 parent c50823f commit b3737bb
Show file tree
Hide file tree
Showing 24 changed files with 96 additions and 96 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ private String getBSDLongName(final String bsdLongName) throws IOException {
}

/**
* Get an extended name from the GNU extended name buffer.
* Gets an extended name from the GNU extended name buffer.
*
* @param offset pointer to entry within the buffer
* @return the extended file name; without trailing "/" if present.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ public int getMode() {
}

/**
* Get this entry's name.
* Gets this entry's name.
*
* <p>This method returns the raw name as it is stored inside of the archive.</p>
*
Expand All @@ -181,7 +181,7 @@ public String getName() {
}

/**
* Get this entry's file size.
* Gets this entry's file size.
*
* @return This entry's file size.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ class Dirent {
}

/**
* Get ino.
* Gets ino.
* @return the i-node
*/
int getIno() {
return ino;
}

/**
* Get name of directory entry.
* Gets name of directory entry.
*
* <p>This method returns the raw name as it is stored inside of the archive.</p>
*
Expand All @@ -62,15 +62,15 @@ String getName() {
}

/**
* Get ino of parent directory.
* Gets ino of parent directory.
* @return the parent i-node
*/
int getParentIno() {
return parentIno;
}

/**
* Get entry type.
* Gets entry type.
* @return the entry type
*/
int getType() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ public Date getAccessTime() {
}

/**
* Get file creation time.
* Gets file creation time.
* @return the creation time
*/
public Date getCreationTime() {
Expand Down Expand Up @@ -594,7 +594,7 @@ public long getSize() {
}

/**
* Get the type of the entry.
* Gets the type of the entry.
* @return the type
*/
public TYPE getType() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ public DumpArchiveEntry getNextEntry() throws IOException {
}

/**
* Get full path for specified archive entry, or null if there's a gap.
* Gets full path for specified archive entry, or null if there's a gap.
*
* @param entry
* @return full path for specified archive entry, or null if there's a gap.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,55 +78,55 @@ public boolean equals(final Object obj) {
}

/**
* Get the device name, e.g., /dev/sda3 or /dev/mapper/vg0-home.
* Gets the device name, e.g., /dev/sda3 or /dev/mapper/vg0-home.
* @return device name
*/
public String getDevname() {
return devname;
}

/**
* Get the date of this dump.
* Gets the date of this dump.
* @return the date of this dump.
*/
public Date getDumpDate() {
return new Date(dumpDate);
}

/**
* Get the last mountpoint, e.g., /home.
* Gets the last mountpoint, e.g., /home.
* @return last mountpoint
*/
public String getFilesystem() {
return filesys;
}

/**
* Get the inode of the first record on this volume.
* Gets the inode of the first record on this volume.
* @return inode of the first record on this volume.
*/
public int getFirstRecord() {
return firstrec;
}

/**
* Get the miscellaneous flags. See below.
* Gets the miscellaneous flags. See below.
* @return flags
*/
public int getFlags() {
return flags;
}

/**
* Get the hostname of the system where the dump was performed.
* Gets the hostname of the system where the dump was performed.
* @return hostname the host name
*/
public String getHostname() {
return hostname;
}

/**
* Get dump label. This may be autogenerated, or it may be specified
* Gets dump label. This may be autogenerated, or it may be specified
* by the user.
* @return dump label
*/
Expand All @@ -135,7 +135,7 @@ public String getLabel() {
}

/**
* Get the level of this dump. This is a number between 0 and 9, inclusive,
* Gets the level of this dump. This is a number between 0 and 9, inclusive,
* and a level 0 dump is a complete dump of the partition. For any other dump
* 'n' this dump contains all files that have changed since the last dump
* at this level or lower. This is used to support different levels of
Expand All @@ -147,7 +147,7 @@ public int getLevel() {
}

/**
* Get the number of records per tape block. This is typically
* Gets the number of records per tape block. This is typically
* between 10 and 32.
* @return the number of records per tape block
*/
Expand All @@ -156,15 +156,15 @@ public int getNTRec() {
}

/**
* Get the date of the previous dump at this level higher.
* Gets the date of the previous dump at this level higher.
* @return dumpdate may be null
*/
public Date getPreviousDumpDate() {
return new Date(previousDumpDate);
}

/**
* Get volume (tape) number.
* Gets volume (tape) number.
* @return volume (tape) number.
*/
public int getVolume() {
Expand Down
Loading

0 comments on commit b3737bb

Please sign in to comment.