com.helger.commons.io.resource.IReadableResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed 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 com.helger.commons.io.resource;

import javax.annotation.Nonnull;

import com.helger.commons.annotation.MustImplementEqualsAndHashcode;
import com.helger.commons.io.IHasInputStreamAndReader;

/**
 * Base interface for an abstract readable resource.
 *
 * @author Philip Helger
 */
@MustImplementEqualsAndHashcode
public interface IReadableResource extends IHasInputStreamAndReader, IResourceBase
{
  /**
   * Get a new resource of the same implementation type as this object but for a
   * different path.
   *
   * @param sPath
   *        The new path to use. May not be null.
   * @return The resource of the same implementation but a different path. May
   *         not be null.
   */
  @Nonnull
  IReadableResource getReadableCloneForPath (@Nonnull String sPath);
}