com.helger.commons.io.resource.inmemory.AbstractMemoryReadableResource 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
The newest version!
/*
 * 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.inmemory;

import java.io.File;
import java.net.URL;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.UnsupportedOperation;
import com.helger.commons.io.resource.IReadableResource;
import com.helger.commons.string.ToStringGenerator;

/**
 * Abstract base class for an {@link IReadableResource} that is not really a
 * resource but where the API does not offer alternatives. These resources
 * cannot be converted to a file or to a URL.
 *
 * @author Philip Helger
 */
public abstract class AbstractMemoryReadableResource implements IMemoryReadableResource
{
  private final String m_sResourceID;

  /**
   * Constructor.
   *
   * @param sResourceID
   *        The mandatory resource ID, used as the cache key. May neither be
   *        null nor empty.
   */
  protected AbstractMemoryReadableResource (@Nonnull @Nonempty final String sResourceID)
  {
    m_sResourceID = ValueEnforcer.notEmpty (sResourceID, "ResourceID");
  }

  /**
   * @return The resource ID as provided in the constructor. Neither
   *         null nor empty.
   */
  @Nonnull
  @Nonempty
  public final String getResourceID ()
  {
    return m_sResourceID;
  }

  @Nonnull
  public String getPath ()
  {
    return "";
  }

  @Nullable
  public URL getAsURL ()
  {
    return null;
  }

  @Nullable
  public File getAsFile ()
  {
    return null;
  }

  public boolean exists ()
  {
    return true;
  }

  @Nonnull
  @UnsupportedOperation
  public IReadableResource getReadableCloneForPath (@Nonnull final String sPath)
  {
    throw new UnsupportedOperationException ("Cannot clone in-memory resource '" +
                                             m_sResourceID +
                                             "' for path '" +
                                             sPath +
                                             "'");
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("ResourceID", m_sResourceID).getToString ();
  }
}