org.llorllale.youtrack.api.Projects Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of youtrack-api Show documentation

Fluent, object-oriented Java API for YouTrack.

There is a newer version: 1.1.0-rc59

/*
 * Copyright 2017 George Aristy
 *
 * 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.llorllale.youtrack.api;

import java.io.IOException;
import java.util.Optional;
import java.util.stream.Stream;

import org.llorllale.youtrack.api.session.Login;
import org.llorllale.youtrack.api.session.UnauthorizedException;

/**
 * Fetches {@link Project projects} from the YouTrack server.
 * @author George Aristy ([email protected])
 * @since 0.4.0
 */
public interface Projects {
  /**
   * Returns a {@link Stream} with all accessible {@link Project projects} by the user's 
   * {@link Login}.
   * @return a {@link Stream} with all accessible {@link Project projects} by the user's 
   *     {@link Login}
   * @throws IOException if the server is unavailable
   * @throws UnauthorizedException if the user's {@link Login} is not authorized to access this
   *     resource
   * @since 0.4.0
   */
  Stream stream() throws IOException, UnauthorizedException;

  /**
   * Returns the {@link Project} with the given {@code id}, if any.
   * @param id the project's {@link Project#id() id}
   * @return the {@link Project} with the given {@code id}, if any
   * @throws IOException if the server is unavailable
   * @throws UnauthorizedException if the user's {@link Login} is not authorized to perform this
   *     operation
   * @since 0.6.0
   */
  Optional get(String id) throws IOException, UnauthorizedException;
}