001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.data.osm.pbf;
003
004import org.openstreetmap.josm.data.osm.BBox;
005
006import jakarta.annotation.Nonnull;
007import jakarta.annotation.Nullable;
008
009/**
010 * The header block contains data on required features, optional features, the bbox of the data, the source, the osmosis replication timestamp,
011 * the osmosis replication sequence number, and the osmosis replication base url
012 * @since 18695
013 */
014public final class HeaderBlock {
015    private final BBox bbox;
016    private final String[] requiredFeatures;
017    private final String[] optionalFeatures;
018    private final String writingProgram;
019    private final String source;
020    private final Long osmosisReplicationTimestamp;
021    private final Long osmosisReplicationSequenceNumber;
022    private final String osmosisReplicationBaseUrl;
023
024    /**
025     * Create a new {@link HeaderBlock} for an OSM PBF file
026     * @param bbox The bbox
027     * @param requiredFeatures The required features
028     * @param optionalFeatures The optional features
029     * @param writingProgram The program used to write the file
030     * @param source The source
031     * @param osmosisReplicationTimestamp The last time that osmosis updated the source (in seconds since epoch)
032     * @param osmosisReplicationSequenceNumber The replication sequence number
033     * @param osmosisReplicationBaseUrl The replication base url
034     */
035    public HeaderBlock(@Nullable BBox bbox, @Nonnull String[] requiredFeatures, @Nonnull String[] optionalFeatures,
036                       @Nullable String writingProgram, @Nullable String source, @Nullable Long osmosisReplicationTimestamp,
037                       @Nullable Long osmosisReplicationSequenceNumber, @Nullable String osmosisReplicationBaseUrl) {
038        this.bbox = bbox;
039        this.requiredFeatures = requiredFeatures;
040        this.optionalFeatures = optionalFeatures;
041        this.writingProgram = writingProgram;
042        this.source = source;
043        this.osmosisReplicationTimestamp = osmosisReplicationTimestamp;
044        this.osmosisReplicationSequenceNumber = osmosisReplicationSequenceNumber;
045        this.osmosisReplicationBaseUrl = osmosisReplicationBaseUrl;
046    }
047
048    /**
049     * The required features to parse the PBF
050     * @return The required features
051     */
052    @Nonnull
053    public String[] requiredFeatures() {
054        return this.requiredFeatures.clone();
055    }
056
057    /**
058     * The optional features to parse the PBF
059     * @return The optional features
060     */
061    @Nonnull
062    public String[] optionalFeatures() {
063        return this.optionalFeatures.clone();
064    }
065
066    /**
067     * Get the program used to write the PBF
068     * @return The program that wrote the PBF
069     */
070    @Nullable
071    public String writingProgram() {
072        return this.writingProgram;
073    }
074
075    /**
076     * The source
077     * @return The source (same as bbox field from OSM)
078     */
079    @Nullable
080    public String source() {
081        return this.source;
082    }
083
084    /**
085     * The replication timestamp
086     * @return The time that the file was last updated
087     */
088    @Nullable
089    public Long osmosisReplicationTimestamp() {
090        return this.osmosisReplicationTimestamp;
091    }
092
093    /**
094     * The replication sequence number
095     * @return The sequence number
096     */
097    @Nullable
098    public Long osmosisReplicationSequenceNumber() {
099        return this.osmosisReplicationSequenceNumber;
100    }
101
102    /**
103     * The replication base URL
104     * @return the base url for replication, if we ever want/need to continue the replication
105     */
106    @Nullable
107    public String osmosisReplicationBaseUrl() {
108        return this.osmosisReplicationBaseUrl;
109    }
110
111    /**
112     * The bbox
113     * @return The bbox
114     */
115    @Nullable
116    public BBox bbox() {
117        return this.bbox;
118    }
119}