org.apache.shindig.gadgets.features.FeatureFile Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shindig-gadgets Show documentation

Renders gadgets, provides the gadget metadata service, and serves all javascript required by the OpenSocial specification.

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.apache.shindig.gadgets.features;

import com.google.inject.ImplementedBy;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;

/**
 * A File Interface used by features to allow different storage then file system
 */
@ImplementedBy(DefaultFeatureFile.class)
public interface FeatureFile {

  /**
   * @return file name
   */
  String getName();

  /**
   * @return file path
   */
  String getPath();

  /**
   * @return file absolute path
   */
  String getAbsolutePath();

  /**
   * @return true if file exists
   */
  boolean exists();

  /**
   * @return true if file can be read
   */
  boolean canRead();

  /**
   * @return true if file is a directory
   */
  boolean isDirectory();

  /**
   * @return list of files in the directory
   */
  FeatureFile[] listFiles() throws IOException;

  /**
   * @return file access in URI format
   */
  URI toURI();

  /**
   * @return InputStream to read file content
   * @throws IOException
   */
  InputStream getInputStream() throws IOException;

  /**
   * @return Return the file content
   * @throws IOException
   */
  String getContent() throws IOException;

  /**
   * @return return the time the file was last modified (miliseconds since epoch, or 0L for error)
   */
  long lastModified();
}