reportbuilder/java/org/libreoffice/report/OutputRepository.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 package org.libreoffice.report;
  19
  20 import java.io.IOException;
  21 import java.io.OutputStream;
  22
  23 /**
  24  * A repository for writing. Providing a repository always assumes,
  25  * that more than one stream can be written.
  26  *
  27  */
  28 public interface OutputRepository
  29 {
  30
  31     /**
  32      * Creates an output stream for writing the data. If there is an entry with
  33      * that name already contained in the repository, try to overwrite it.
  34      *
  35      * @param name
  36      *    the name of the output stream
  37      * @param mimeType
  38      *    the mime type of the to-be-created output stream. Repository implementations which do not support
  39      *    associating a mime time with a stream might ignore this parameter.
  40      * @return the outputstream
  41      * @throws IOException if opening the stream fails
  42      */
  43     OutputStream createOutputStream(final String name, final String mimeType) throws IOException;
  44
  45     /** allows to access sub repositories inside this repository
  46      *
  47      * @param name describes the path to the sub repository
  48      * @param mimeType
  49      * @return the sub repository
  50      * @throws java.io.IOException when the sub repository doesn't exist.
  51      */
  52     OutputRepository openOutputRepository(final String name, final String mimeType) throws IOException;
  53
  54     boolean exists(final String name);
  55
  56     boolean existsStorage(final String name);
  57
  58
  59
  60     void closeOutputRepository();
  61 }