View Javadoc
1   package org.codehaus.mojo.truezip;
2   
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   * Customizes the string representation of <code>org.apache.maven.shared.model.fileset.FileSet</code> to return the
24   * included and excluded files from the file-set's directory. Specifically,
25   * <code>"file-set: <I>[directory]</I> (included: <I>[included files]</I>,
26   * excluded: <I>[excluded files]</I>)"</code>
27   * 
28   * @since 1.0-beta-3
29   * @see org.apache.maven.shared.model.fileset.FileSet
30   */
31  public class Fileset
32      extends TrueZipFileSet
33  {
34      public static final long serialVersionUID = -1;
35  
36      /**
37       * Retrieves the included and excluded files from this file-set's directory. Specifically,
38       * <code>"file-set: <I>[directory]</I> (included:
39       * <I>[included files]</I>, excluded: <I>[excluded files]</I>)"</code>
40       * 
41       * @return The included and excluded files from this file-set's directory. Specifically,
42       *         <code>"file-set: <I>[directory]</I> (included:
43       * <I>[included files]</I>, excluded: <I>[excluded files]</I>)"</code>
44       * @see java.lang.Object#toString()
45       */
46      public String toString()
47      {
48          return "file-set: " + getDirectory() + " (included: " + getIncludes() + ", excluded: " + getExcludes() + ")";
49      }
50  }