geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From strub...@apache.org
Subject svn commit: r1623066 - in /geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail: EncodingAware.java MailSessionDefinition.java MailSessionDefinitions.java
Date Sun, 07 Sep 2014 16:25:55 GMT
Author: struberg
Date: Sun Sep  7 16:25:55 2014
New Revision: 1623066

URL: http://svn.apache.org/r1623066
Log:
GERONIMO-6530 add missing license headers

I also wrote new JavaDoc for those classes

Modified:
    geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/EncodingAware.java
    geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/MailSessionDefinition.java
    geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/MailSessionDefinitions.java

Modified: geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/EncodingAware.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/EncodingAware.java?rev=1623066&r1=1623065&r2=1623066&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/EncodingAware.java
(original)
+++ geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/EncodingAware.java
Sun Sep  7 16:25:55 2014
@@ -1,27 +1,28 @@
+/*
+ * 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.
+ */
 package javax.mail;
 
 /**
- * A {@link javax.activation.DataSource DataSource} that also implements
- * EncodingAware may specify the Content-Transfer-Encoding
+ * A class that implements EncodingAware may specify the Content-Transfer-Encoding
  * to use for its data.  Valid Content-Transfer-Encoding values specified
  * by RFC 2045 are "7bit", "8bit", "quoted-printable", "base64", and "binary".
- * 
- * For example, a {@link javax.activation.FileDataSource FileDataSource}
- * could be created that forces all files to be base64 encoded: 
- * 
- *  public class Base64FileDataSource extends FileDataSource
- *                  implements EncodingAware {
- *  public Base64FileDataSource(File file) {
- *      super(file);
- *  }
- *
- *  // implements EncodingAware.getEncoding()
- *  public String getEncoding() {
- *      return "base64";
- *  }
- *  }
- * 
-
+ * This is mainly used for {@link javax.activation.DataSource DataSource}s.
  *
  * @since   JavaMail 1.5
  */
@@ -29,11 +30,9 @@ package javax.mail;
 public interface EncodingAware {
 
     /**
-     * Return the MIME Content-Transfer-Encoding to use for this data,
+     * @return the MIME Content-Transfer-Encoding to use for this data,
      * or null to indicate that an appropriate value should be chosen
      * by the caller.
-     *
-     * @return      the Content-Transfer-Encoding value, or null
      */
     public String getEncoding();
 }

Modified: geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/MailSessionDefinition.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/MailSessionDefinition.java?rev=1623066&r1=1623065&r2=1623066&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/MailSessionDefinition.java
(original)
+++ geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/MailSessionDefinition.java
Sun Sep  7 16:25:55 2014
@@ -1,3 +1,21 @@
+/*
+ * 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.
+ */
 package javax.mail;
 
 import java.lang.annotation.ElementType;
@@ -7,14 +25,13 @@ import java.lang.annotation.Target;
 
 /**
  * Annotation used by Java EE applications to define a MailSession
- * to be registered with JNDI.  The MailSession may be configured
- * by setting the annotation elements for commonly used Session
- * properties.  Additional standard and vendor-specific properties may be
+ * to be registered within JNDI.
+ * The annotation is used to configure the commonly used Session
+ * properties.
+ * Additional standard and vendor-specific properties may be
  * specified using the properties element.
  * 
-
-
- * The session will be registered under the name specified in the
+ * The session will be registered under the JNDI name specified in the
  * name element.  It may be defined to be in any valid
  * Java EE namespace, and will determine the accessibility of
  * the session from other components.

Modified: geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/MailSessionDefinitions.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/MailSessionDefinitions.java?rev=1623066&r1=1623065&r2=1623066&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/MailSessionDefinitions.java
(original)
+++ geronimo/specs/trunk/geronimo-javamail_1.5_spec/src/main/java/javax/mail/MailSessionDefinitions.java
Sun Sep  7 16:25:55 2014
@@ -1,3 +1,21 @@
+/*
+ * 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.
+ */
 package javax.mail;
 
 import java.lang.annotation.ElementType;
@@ -6,7 +24,7 @@ import java.lang.annotation.RetentionPol
 import java.lang.annotation.Target;
 
 /**
- * Declares one or more MailSessionDefinition annotations.
+ * Declares MailSessionDefinition annotations.
  *
  * @see MailSessionDefinition
  * @since JavaMail 1.5



Mime
View raw message