View Javadoc

1   /*
2    * $Id: ReloadableDefinitionsFactory.java 527870 2007-04-12 10:19:41Z apetrelli $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  
23  package org.apache.tiles.definition;
24  
25  /***
26   * Indicates support for reloading Tiles configuration when it changes.
27   *
28   * @version $Rev: 527870 $ $Date: 2007-04-12 12:19:41 +0200 (Thu, 12 Apr 2007) $
29   */
30  public interface ReloadableDefinitionsFactory {
31  
32      /***
33       * Indicates whether the DefinitionsFactory is out of date and needs to be
34       * reloaded.
35       *
36       * @return <code>true</code> if the definitions need to be refreshed.
37       */
38      boolean refreshRequired();
39  
40      /***
41       * Refreshes the stored definitions, reloading them.
42       *
43       * @throws DefinitionsFactoryException If something goes wrong during
44       * refresh.
45       */
46      void refresh() throws DefinitionsFactoryException;
47  }