NET-636 examples should be in org.apache.commons.net subpackage

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/net/trunk@1792230 13f79535-47bb-0310-9956-ffa450edef68

Author: sebbASF

pom.xml

@@ -232,7 +232,7 @@ Supported protocols include: Echo, Finger, FTP, NNTP, NTP, POP3(S), SMTP(S), Tel
                 <artifactId>maven-jar-plugin</artifactId>
                 <configuration>
                     <excludes>
-                        <exclude>examples/**</exclude>
+                        <exclude>**/examples/**</exclude>
                     </excludes>
                 </configuration>
             </plugin>
@@ -243,7 +243,7 @@ Supported protocols include: Echo, Finger, FTP, NNTP, NTP, POP3(S), SMTP(S), Tel
                 <artifactId>maven-source-plugin</artifactId>
                 <configuration>
                     <excludes>
-                        <exclude>examples/**</exclude>
+                        <exclude>**/examples/**</exclude>
                     </excludes>
                 </configuration>
             </plugin>
@@ -309,11 +309,11 @@ Supported protocols include: Echo, Finger, FTP, NNTP, NTP, POP3(S), SMTP(S), Tel
                                         <attribute name="X-Compile-Source-JDK" value="${maven.compiler.source}" />
                                         <attribute name="X-Compile-Target-JDK" value="${maven.compiler.target}" />
                                         <!-- Helper application -->
-                                        <attribute name="Main-Class" value="examples/Main" />
+                                        <attribute name="Main-Class" value="org/apache/commons/net/examples/Main" />
                                         <!-- Allow java -jar examples.jar to work -->
                                         <attribute name="Class-Path" value="commons-net-${project.version}.jar" />
                                     </manifest>
-                                    <fileset dir="target/classes" includes="examples/**" />
+                                    <fileset dir="target/classes" includes="**/examples/**" />
                                 </jar>
                             </target>
                         </configuration>
@@ -358,7 +358,7 @@ Supported protocols include: Echo, Finger, FTP, NNTP, NTP, POP3(S), SMTP(S), Tel
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
                 <configuration>
-                    <excludePackageNames>examples.*</excludePackageNames>
+                    <excludePackageNames>*.examples.*</excludePackageNames>
                 </configuration>
             </plugin>
 
@@ -376,7 +376,7 @@ Supported protocols include: Echo, Finger, FTP, NNTP, NTP, POP3(S), SMTP(S), Tel
                     <outputDirectory>${basedir}/target/site/examples</outputDirectory>
                     <resources>
                       <resource>
-                        <directory>src/main/java/examples</directory>
+                        <directory>src/main/java/org/apache/commons/net/examples</directory>
                         <excludes>
                           <exclude>**/Main.java</exclude>
                         </excludes>
@@ -403,7 +403,7 @@ Supported protocols include: Echo, Finger, FTP, NNTP, NTP, POP3(S), SMTP(S), Tel
               <artifactId>clirr-maven-plugin</artifactId>
               <configuration>
                   <excludes>
-                    <exclude>examples/**</exclude>
+                    <exclude>**/examples/**</exclude>
                   </excludes>
               </configuration>
           </plugin>
@@ -426,7 +426,7 @@ Supported protocols include: Echo, Finger, FTP, NNTP, NTP, POP3(S), SMTP(S), Tel
           </execution>
         </executions>
         <configuration>
-          <mainClass>examples.Main</mainClass>
+          <mainClass>org.apache.commons.net.examples.Main</mainClass>
         </configuration>
       </plugin>
 
@@ -464,7 +464,7 @@ Supported protocols include: Echo, Finger, FTP, NNTP, NTP, POP3(S), SMTP(S), Tel
                 <artifactId>clirr-maven-plugin</artifactId>
                 <configuration>
                     <excludes>
-                      <exclude>examples/**</exclude>
+                      <exclude>**/examples/**</exclude>
                     </excludes>
                 </configuration>
             </plugin>
@@ -473,7 +473,7 @@ Supported protocols include: Echo, Finger, FTP, NNTP, NTP, POP3(S), SMTP(S), Tel
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
                 <configuration>
-                    <excludePackageNames>examples.*</excludePackageNames>
+                    <excludePackageNames>*.examples.*</excludePackageNames>
                 </configuration>
             </plugin>
 

src/assembly/bin.xml

@@ -65,8 +65,8 @@ Licensed to the Apache Software Foundation (ASF) under one or more
         </fileSet>
         <!-- Include example sources for developers -->
         <fileSet>
-            <directory>src/main/java/examples</directory>
-            <outputDirectory>examples</outputDirectory>
+            <directory>src/main/java/org/apache/commons/net/examples</directory>
+            <outputDirectory>org/apache/commons/net/examples</outputDirectory>
             <includes>
                 <include>**/*</include>
             </includes>

src/changes/changes.xml

@@ -70,7 +70,13 @@ This is mainly a bug-fix release. See further details below.
  This release is binary compatible with previous releases.
  However it is not source compatible with releases before 3.4, as some methods were added to the interface NtpV3Packet in 3.4
 
+ Note that the examples packages were moved under org/apache/commons/net/examples.
+ The examples are not part of the public API, so this does not affect compatibility.
+
 ">
+            <action issue="NET-636" type="fix" dev="sebb">
+            examples should be in org.apache.commons.net subpackage
+            </action>
             <action issue="NET-634" type="add" dev="sebb" due-to="Mauro Molinari">
             Add SIZE command support
             </action>

src/main/java/examples/Main.java renamed to src/main/java/org/apache/commons/net/examples/Main.java

@@ -16,7 +16,7 @@
  *
  */
 
-package examples;
+package org.apache.commons.net.examples;
 
 import java.io.InputStream;
 import java.lang.reflect.InvocationTargetException;

src/main/java/examples/cidr/SubnetUtilsExample.java renamed to src/main/java/org/apache/commons/net/examples/cidr/SubnetUtilsExample.java

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package examples.cidr;
+package org.apache.commons.net.examples.cidr;
 
 import java.util.Arrays;
 import java.util.Scanner;

src/main/java/examples/ftp/FTPClientExample.java renamed to src/main/java/org/apache/commons/net/examples/ftp/FTPClientExample.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.ftp;
+package org.apache.commons.net.examples.ftp;
 
 import java.io.FileInputStream;
 import java.io.FileOutputStream;

src/main/java/examples/ftp/ServerToServerFTP.java renamed to src/main/java/org/apache/commons/net/examples/ftp/ServerToServerFTP.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.ftp;
+package org.apache.commons.net.examples.ftp;
 
 import java.io.IOException;
 import java.io.PrintWriter;

src/main/java/examples/ftp/TFTPExample.java renamed to src/main/java/org/apache/commons/net/examples/ftp/TFTPExample.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.ftp;
+package org.apache.commons.net.examples.ftp;
 
 import java.io.Closeable;
 import java.io.File;

src/main/java/examples/mail/IMAPExportMbox.java renamed to src/main/java/org/apache/commons/net/examples/mail/IMAPExportMbox.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.mail;
+package org.apache.commons.net.examples.mail;
 
 import java.io.BufferedWriter;
 import java.io.File;

src/main/java/examples/mail/IMAPImportMbox.java renamed to src/main/java/org/apache/commons/net/examples/mail/IMAPImportMbox.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.mail;
+package org.apache.commons.net.examples.mail;
 
 import java.io.BufferedReader;
 import java.io.File;

src/main/java/examples/mail/IMAPMail.java renamed to src/main/java/org/apache/commons/net/examples/mail/IMAPMail.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.mail;
+package org.apache.commons.net.examples.mail;
 
 import java.io.IOException;
 import java.net.URI;

src/main/java/examples/mail/IMAPUtils.java renamed to src/main/java/org/apache/commons/net/examples/mail/IMAPUtils.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.mail;
+package org.apache.commons.net.examples.mail;
 
 import java.io.IOException;
 import java.net.URI;

src/main/java/examples/mail/POP3ExportMbox.java renamed to src/main/java/org/apache/commons/net/examples/mail/POP3ExportMbox.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.mail;
+package org.apache.commons.net.examples.mail;
 
 import java.io.BufferedReader;
 import java.io.File;

src/main/java/examples/mail/POP3Mail.java renamed to src/main/java/org/apache/commons/net/examples/mail/POP3Mail.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.mail;
+package org.apache.commons.net.examples.mail;
 
 import java.io.BufferedReader;
 import java.io.IOException;

src/main/java/examples/mail/SMTPMail.java renamed to src/main/java/org/apache/commons/net/examples/mail/SMTPMail.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.mail;
+package org.apache.commons.net.examples.mail;
 
 import java.io.BufferedReader;
 import java.io.FileNotFoundException;

src/main/java/examples/mail/Utils.java renamed to src/main/java/org/apache/commons/net/examples/mail/Utils.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.mail;
+package org.apache.commons.net.examples.mail;
 
 import java.io.BufferedReader;
 import java.io.Console;

src/main/java/examples/nntp/ArticleReader.java renamed to src/main/java/org/apache/commons/net/examples/nntp/ArticleReader.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.nntp;
+package org.apache.commons.net.examples.nntp;
 
 import java.io.BufferedReader;
 import java.io.IOException;

src/main/java/examples/nntp/ExtendedNNTPOps.java renamed to src/main/java/org/apache/commons/net/examples/nntp/ExtendedNNTPOps.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.nntp;
+package org.apache.commons.net.examples.nntp;
 
 import java.io.IOException;
 import java.io.PrintWriter;

src/main/java/examples/nntp/ListNewsgroups.java renamed to src/main/java/org/apache/commons/net/examples/nntp/ListNewsgroups.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.nntp;
+package org.apache.commons.net.examples.nntp;
 
 import java.io.IOException;
 import org.apache.commons.net.nntp.NNTPClient;

src/main/java/examples/nntp/MessageThreading.java renamed to src/main/java/org/apache/commons/net/examples/nntp/MessageThreading.java

@@ -16,7 +16,7 @@
  */
 
 
-package examples.nntp;
+package org.apache.commons.net.examples.nntp;
 
 import java.io.IOException;
 import java.io.PrintWriter;

src/main/java/examples/nntp/NNTPUtils.java renamed to src/main/java/org/apache/commons/net/examples/nntp/NNTPUtils.java

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package examples.nntp;
+package org.apache.commons.net.examples.nntp;
 
 import java.io.IOException;
 import java.util.ArrayList;

src/main/java/examples/nntp/PostMessage.java renamed to src/main/java/org/apache/commons/net/examples/nntp/PostMessage.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.nntp;
+package org.apache.commons.net.examples.nntp;
 
 import java.io.BufferedReader;
 import java.io.FileNotFoundException;

src/main/java/examples/ntp/NTPClient.java renamed to src/main/java/org/apache/commons/net/examples/ntp/NTPClient.java

@@ -1,4 +1,4 @@
-package examples.ntp;
+package org.apache.commons.net.examples.ntp;
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with

src/main/java/examples/ntp/SimpleNTPServer.java renamed to src/main/java/org/apache/commons/net/examples/ntp/SimpleNTPServer.java

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package examples.ntp;
+package org.apache.commons.net.examples.ntp;
 
 import org.apache.commons.net.ntp.NtpUtils;
 import org.apache.commons.net.ntp.NtpV3Impl;

src/main/java/examples/ntp/TimeClient.java renamed to src/main/java/org/apache/commons/net/examples/ntp/TimeClient.java

@@ -1,4 +1,4 @@
-package examples.ntp;
+package org.apache.commons.net.examples.ntp;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more

src/main/java/org/apache/commons/net/examples/package-info.java

@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+
+/**
+ * Example classes.
+ * <p>
+ * <b>These do not form part of the public API and may change without notice.</b>
+ */
+package org.apache.commons.net.examples;

src/main/java/examples/telnet/TelnetClientExample.java renamed to src/main/java/org/apache/commons/net/examples/telnet/TelnetClientExample.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.telnet;
+package org.apache.commons.net.examples.telnet;
 
 import java.io.IOException;
 import java.io.InputStream;

src/main/java/examples/telnet/WeatherTelnet.java renamed to src/main/java/org/apache/commons/net/examples/telnet/WeatherTelnet.java

@@ -15,12 +15,12 @@
  * limitations under the License.
  */
 
-package examples.telnet;
+package org.apache.commons.net.examples.telnet;
 
 import java.io.IOException;
 import org.apache.commons.net.telnet.TelnetClient;
 
-import examples.util.IOUtil;
+import org.apache.commons.net.examples.util.IOUtil;
 
 /***
  * This is an example of a trivial use of the TelnetClient class.

src/main/java/examples/unix/chargen.java renamed to src/main/java/org/apache/commons/net/examples/unix/chargen.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.unix;
+package org.apache.commons.net.examples.unix;
 
 import java.io.BufferedReader;
 import java.io.IOException;

src/main/java/examples/unix/daytime.java renamed to src/main/java/org/apache/commons/net/examples/unix/daytime.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.unix;
+package org.apache.commons.net.examples.unix;
 
 import java.io.IOException;
 import java.net.InetAddress;

src/main/java/examples/unix/echo.java renamed to src/main/java/org/apache/commons/net/examples/unix/echo.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.unix;
+package org.apache.commons.net.examples.unix;
 
 import java.io.BufferedReader;
 import java.io.IOException;

src/main/java/examples/unix/finger.java renamed to src/main/java/org/apache/commons/net/examples/unix/finger.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.unix;
+package org.apache.commons.net.examples.unix;
 
 import java.io.IOException;
 import java.net.InetAddress;

src/main/java/examples/unix/fwhois.java renamed to src/main/java/org/apache/commons/net/examples/unix/fwhois.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package examples.unix;
+package org.apache.commons.net.examples.unix;
 
 import java.io.IOException;
 import java.net.InetAddress;