jakarta.mail.BodyPart Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.mail;
import jakarta.mail.util.StreamProvider;
/**
* This class models a Part that is contained within a Multipart.
* This is an abstract class. Subclasses provide actual implementations.
*
* BodyPart implements the Part interface. Thus, it contains a set of
* attributes and a "content".
*
* @author John Mani
* @author Bill Shannon
*/
public abstract class BodyPart implements Part {
/**
* The Multipart
object containing this BodyPart
,
* if known.
* @since JavaMail 1.1
*/
protected Multipart parent;
/**
* Instance of stream provider.
*
* @since JavaMail 2.1
*/
protected final StreamProvider streamProvider = StreamProvider.provider();
/**
* Creates a default {@code BodyPart}.
*/
public BodyPart() {
}
/**
* Return the containing Multipart
object,
* or null
if not known.
*
* @return the parent Multipart
*/
public Multipart getParent() {
return parent;
}
/**
* Set the parent of this BodyPart
to be the specified
* Multipart
. Normally called by Multipart
's
* addBodyPart
method. parent
may be
* null
if the BodyPart
is being removed
* from its containing Multipart
.
* @since JavaMail 1.1
*/
void setParent(Multipart parent) {
this.parent = parent;
}
}