blob: 0834de1a6ff2af38df8f2af92834537123f1e551 [file] [log] [blame]
/*
* Copyright (c) 2005, 2018 IBM Corporation, CEA, and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* IBM - initial API and implementation
* Kenn Hussey (CEA) - 327039, 418466, 451350
* Christian W. Damus (CEA) - 251963
* Kenn Hussey - 535301
*
*/
package org.eclipse.uml2.uml;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Image</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* Physical definition of a graphical image.
* <p>From package UML::Packages.</p>
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.uml2.uml.Image#getContent <em>Content</em>}</li>
* <li>{@link org.eclipse.uml2.uml.Image#getFormat <em>Format</em>}</li>
* <li>{@link org.eclipse.uml2.uml.Image#getLocation <em>Location</em>}</li>
* </ul>
*
* @see org.eclipse.uml2.uml.UMLPackage#getImage()
* @model
* @generated
*/
public interface Image
extends Element {
/**
* Returns the value of the '<em><b>Content</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* This contains the serialization of the image according to the format. The value could represent a bitmap, image such as a GIF file, or drawing 'instructions' using a standard such as Scalable Vector Graphic (SVG) (which is XML based).
* <p>From package UML::Packages.</p>
* <!-- end-model-doc -->
* @return the value of the '<em>Content</em>' attribute.
* @see #isSetContent()
* @see #unsetContent()
* @see #setContent(String)
* @see org.eclipse.uml2.uml.UMLPackage#getImage_Content()
* @model unsettable="true" dataType="org.eclipse.uml2.types.String" ordered="false"
* @generated
*/
String getContent();
/**
* Sets the value of the '{@link org.eclipse.uml2.uml.Image#getContent <em>Content</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Content</em>' attribute.
* @see #isSetContent()
* @see #unsetContent()
* @see #getContent()
* @generated
*/
void setContent(String value);
/**
* Unsets the value of the '{@link org.eclipse.uml2.uml.Image#getContent <em>Content</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetContent()
* @see #getContent()
* @see #setContent(String)
* @generated
*/
void unsetContent();
/**
* Returns whether the value of the '{@link org.eclipse.uml2.uml.Image#getContent <em>Content</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Content</em>' attribute is set.
* @see #unsetContent()
* @see #getContent()
* @see #setContent(String)
* @generated
*/
boolean isSetContent();
/**
* Returns the value of the '<em><b>Location</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* This contains a location that can be used by a tool to locate the image as an alternative to embedding it in the stereotype.
* <p>From package UML::Packages.</p>
* <!-- end-model-doc -->
* @return the value of the '<em>Location</em>' attribute.
* @see #isSetLocation()
* @see #unsetLocation()
* @see #setLocation(String)
* @see org.eclipse.uml2.uml.UMLPackage#getImage_Location()
* @model unsettable="true" dataType="org.eclipse.uml2.types.String" ordered="false"
* @generated
*/
String getLocation();
/**
* Sets the value of the '{@link org.eclipse.uml2.uml.Image#getLocation <em>Location</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Location</em>' attribute.
* @see #isSetLocation()
* @see #unsetLocation()
* @see #getLocation()
* @generated
*/
void setLocation(String value);
/**
* Unsets the value of the '{@link org.eclipse.uml2.uml.Image#getLocation <em>Location</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetLocation()
* @see #getLocation()
* @see #setLocation(String)
* @generated
*/
void unsetLocation();
/**
* Returns whether the value of the '{@link org.eclipse.uml2.uml.Image#getLocation <em>Location</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Location</em>' attribute is set.
* @see #unsetLocation()
* @see #getLocation()
* @see #setLocation(String)
* @generated
*/
boolean isSetLocation();
/**
* Returns the value of the '<em><b>Format</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* This indicates the format of the content, which is how the string content should be interpreted. The following values are reserved: SVG, GIF, PNG, JPG, WMF, EMF, BMP. In addition the prefix 'MIME: ' is also reserved. This option can be used as an alternative to express the reserved values above, for example "SVG" could instead be expressed as "MIME: image/svg+xml".
* <p>From package UML::Packages.</p>
* <!-- end-model-doc -->
* @return the value of the '<em>Format</em>' attribute.
* @see #isSetFormat()
* @see #unsetFormat()
* @see #setFormat(String)
* @see org.eclipse.uml2.uml.UMLPackage#getImage_Format()
* @model unsettable="true" dataType="org.eclipse.uml2.types.String" ordered="false"
* @generated
*/
String getFormat();
/**
* Sets the value of the '{@link org.eclipse.uml2.uml.Image#getFormat <em>Format</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Format</em>' attribute.
* @see #isSetFormat()
* @see #unsetFormat()
* @see #getFormat()
* @generated
*/
void setFormat(String value);
/**
* Unsets the value of the '{@link org.eclipse.uml2.uml.Image#getFormat <em>Format</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetFormat()
* @see #getFormat()
* @see #setFormat(String)
* @generated
*/
void unsetFormat();
/**
* Returns whether the value of the '{@link org.eclipse.uml2.uml.Image#getFormat <em>Format</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Format</em>' attribute is set.
* @see #unsetFormat()
* @see #getFormat()
* @see #setFormat(String)
* @generated
*/
boolean isSetFormat();
String FORMAT_SVG = "SVG"; //$NON-NLS-1$
String FORMAT_GIF = "GIF"; //$NON-NLS-1$
String FORMAT_PNG = "PNG"; //$NON-NLS-1$
String FORMAT_JPG = "JPG"; //$NON-NLS-1$
String FORMAT_WMF = "WMF"; //$NON-NLS-1$
String FORMAT_EMF = "EMF"; //$NON-NLS-1$
String FORMAT_BMP = "BMP"; //$NON-NLS-1$
String FORMAT_PREFIX_MIME = "MIME: "; //$NON-NLS-1$
} // Image