org.dmfs.rfc3986.Path Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rfc3986-uri Show documentation

RFC 3986 compliant URI implementation.

There is a newer version: 0.8.1

/*
 * Copyright 2017 dmfs GmbH
 *
 * 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 org.dmfs.rfc3986;

import org.dmfs.rfc3986.paths.Text;


/**
 * Represents the path component of a {@link Uri}.
 * 
 * Use {@link Text} to convert a {@link Path} into an encoded {@link CharSequence}.
 *
 * @author Marten Gajda
 */
public interface Path extends Iterable
{
    /**
     * Returns whether this path is empty, i.e. contains no path segments.
     *
     * @return {@code true} if this path is empty, {@code false} otherwise.
     */
    boolean isEmpty();

    /**
     * Returns whether this path is absolute, i.e. starts with a "/".
     *
     * @return {@code true} if this path is absolute, {@code false} otherwise.
     */
    boolean isAbsolute();
}