GP-0: Improving javadoc of OverlayAddressSpace.getAddress methods

(Closes #9181)
This commit is contained in:
Ryan Kurtz
2026-05-29 10:33:25 -04:00
parent 01009fdeea
commit be76bde4a2

View File

@@ -58,6 +58,12 @@ public abstract class OverlayAddressSpace extends AbstractAddressSpace {
return Objects.hash(orderedKey, baseSpace);
}
/**
* {@inheritDoc}
* <p>
* NOTE: This overridden method behaves like {@link #getAddress(long)}, not
* {@link #getAddressInThisSpaceOnly(long)}
*/
@Override
public Address getAddress(String addrString, boolean caseSensitive)
throws AddressFormatException {
@@ -124,6 +130,12 @@ public abstract class OverlayAddressSpace extends AbstractAddressSpace {
return new GenericAddress(offset, this);
}
/**
* {@inheritDoc}
* <p>
* NOTE: If the offset is not contained in the bounds of the overlay region, the offset into the
* base space is returned.
*/
@Override
public Address getAddress(long offset) {
if (contains(offset)) {