TileStoreEntry.java

/*******************************************************************************
 * Copyright (c) MOBAC developers
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package mobac.program.tilestore;

public interface TileStoreEntry {

	public int getX();

	public int getY();

	public int getZoom();

	/**
	 * This function does never return a <code>null</code> value!
	 * 
	 * @return tile data
	 */
	public byte[] getData();

	/**
	 * The time and date in UTC when this map tile has been downloaded
	 * respectively has been checked the last time via HTTP If-None-Match,
	 * If-Modified-Since or a HTTP HEAD request.
	 * 
	 * @return Time in UTC
	 */
	public long getTimeDownloaded();

	public void update(long timeExpires);
	
	/**
	 * 
	 * @return Last modification time in UTC or <code>0</code> if not supported
	 *         by the server
	 */
	public long getTimeLastModified();

	/**
	 * 
	 * @return Expiration time in UTC or <code>0</code> if not supported by the
	 *         server
	 */
	public long getTimeExpires();

	/**
	 * The eTag contained in the HTTP answer on the last download/check request.
	 * 
	 * @return eTag or <code>null</code> if not supported by the server
	 */
	public String geteTag();

}