001    /*
002     * Copyright 2002-2004 the original author or authors.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not
005     * use this file except in compliance with the License. You may obtain a copy of
006     * the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
012     * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
013     * License for the specific language governing permissions and limitations under
014     * the License.
015     */
016    package org.springframework.richclient.core;
017    
018    import javax.swing.JComponent;
019    
020    /**
021     * An interface to be implemented by classes that represent a user-oriented
022     * message and are capable of rendering themselves on GUI components.
023     *
024     * @see JComponent
025     */
026    public interface Message {
027    
028            /**
029             * Timestamp in long format of the message creation.
030             */
031            long getTimestamp();
032    
033            /**
034             * The textual representation of the message. This is not necessarily how
035             * the message will appear on a GUI component.
036             *
037             * @return textual message, never <code>null</code>, but possibly an
038             * empty string.
039             */
040            String getMessage();
041    
042            /**
043             * Return the {@link Severity} of this message, possibly <code>null</code>.
044             */
045            Severity getSeverity();
046    
047            /**
048             * Decorate the given component with this message.
049             *
050             * @param component visual component to decorate.
051             */
052            void renderMessage(JComponent component);
053    
054    }