com.wavemaker.commons.io.ResourceStringFormat Maven / Gradle / Ivy

Go to download

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

wavemaker-commons-util

There is a newer version: 11.9.5.ee

Show newest version

/*******************************************************************************
 * Copyright (C) 2022-2023 WaveMaker, Inc.
 *
 * 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.wavemaker.commons.io;

/**
 * Formats that can be used to display a {@link Resource} name. See {@link Resource#toString(ResourceStringFormat)}.
 *
 * @author Phillip Webb
 */
public enum ResourceStringFormat {

    /**
     * The full name of the resource, for example "/folder/file.txt" or "/folder/". Note: any jailed
     * elements of the path are excluded.
     */
    FULL,

    /**
     * The full unjailed path of the resource, for example "/jail/folder/file.txt" or "/jail/folder/".
     * Note: any jailed elements of the path are excluded.
     */
    UNJAILED,
}