Package org.openstreetmap.josm.data.osm.pbf

Class HeaderBlock

java.lang.Object

org.openstreetmap.josm.data.osm.pbf.HeaderBlock

public final class HeaderBlock
extends java.lang.Object

The header block contains data on required features, optional features, the bbox of the data, the source, the osmosis replication timestamp, the osmosis replication sequence number, and the osmosis replication base url

Since:

18695

Field Summary

Fields

Modifier and Type	Field	Description
private BBox	bbox
private java.lang.String[]	optionalFeatures
private java.lang.String	osmosisReplicationBaseUrl
private java.lang.Long	osmosisReplicationSequenceNumber
private java.lang.Long	osmosisReplicationTimestamp
private java.lang.String[]	requiredFeatures
private java.lang.String	source
private java.lang.String	writingProgram

Constructor Summary

Constructors

Constructor	Description
HeaderBlock(BBox bbox, java.lang.String[] requiredFeatures, java.lang.String[] optionalFeatures, java.lang.String writingProgram, java.lang.String source, java.lang.Long osmosisReplicationTimestamp, java.lang.Long osmosisReplicationSequenceNumber, java.lang.String osmosisReplicationBaseUrl)	Create a new HeaderBlock for an OSM PBF file

Method Summary

Modifier and Type	Method	Description
BBox	bbox()	The bbox
java.lang.String[]	optionalFeatures()	The optional features to parse the PBF
java.lang.String	osmosisReplicationBaseUrl()	The replication base URL
java.lang.Long	osmosisReplicationSequenceNumber()	The replication sequence number
java.lang.Long	osmosisReplicationTimestamp()	The replication timestamp
java.lang.String[]	requiredFeatures()	The required features to parse the PBF
java.lang.String	source()	The source
java.lang.String	writingProgram()	Get the program used to write the PBF

Methods inherited from class java.lang.Object

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

Field Detail

bbox

private final BBox bbox

requiredFeatures

private final java.lang.String[] requiredFeatures

optionalFeatures

private final java.lang.String[] optionalFeatures

writingProgram

private final java.lang.String writingProgram

source

private final java.lang.String source

osmosisReplicationTimestamp

private final java.lang.Long osmosisReplicationTimestamp

osmosisReplicationSequenceNumber

private final java.lang.Long osmosisReplicationSequenceNumber

osmosisReplicationBaseUrl

private final java.lang.String osmosisReplicationBaseUrl

Constructor Detail

HeaderBlock

public HeaderBlock(@Nullable
                   BBox bbox,
                   @Nonnull
                   java.lang.String[] requiredFeatures,
                   @Nonnull
                   java.lang.String[] optionalFeatures,
                   @Nullable
                   java.lang.String writingProgram,
                   @Nullable
                   java.lang.String source,
                   @Nullable
                   java.lang.Long osmosisReplicationTimestamp,
                   @Nullable
                   java.lang.Long osmosisReplicationSequenceNumber,
                   @Nullable
                   java.lang.String osmosisReplicationBaseUrl)

Create a new HeaderBlock for an OSM PBF file

Parameters:

bbox - The bbox

requiredFeatures - The required features

optionalFeatures - The optional features

writingProgram - The program used to write the file

source - The source

osmosisReplicationTimestamp - The last time that osmosis updated the source (in seconds since epoch)

osmosisReplicationSequenceNumber - The replication sequence number

osmosisReplicationBaseUrl - The replication base url

Method Detail

requiredFeatures

@Nonnull
public java.lang.String[] requiredFeatures()

The required features to parse the PBF

Returns:

The required features

optionalFeatures

@Nonnull
public java.lang.String[] optionalFeatures()

The optional features to parse the PBF

Returns:

The optional features

writingProgram

@Nullable
public java.lang.String writingProgram()

Get the program used to write the PBF

Returns:

The program that wrote the PBF

source

@Nullable
public java.lang.String source()

The source

Returns:

The source (same as bbox field from OSM)

osmosisReplicationTimestamp

@Nullable
public java.lang.Long osmosisReplicationTimestamp()

The replication timestamp

Returns:

The time that the file was last updated

osmosisReplicationSequenceNumber

@Nullable
public java.lang.Long osmosisReplicationSequenceNumber()

The replication sequence number

Returns:

The sequence number

osmosisReplicationBaseUrl

@Nullable
public java.lang.String osmosisReplicationBaseUrl()

The replication base URL

Returns:

the base url for replication, if we ever want/need to continue the replication

bbox

@Nullable
public BBox bbox()

The bbox

Returns:

The bbox