← Back to branch summary

~ubuntu-branches/ubuntu/utopic/eclipse-eclox/utopic

« back to all changes in this revision

Viewing changes to eclox.core/src/eclox/core/doxyfiles/Chunk.java

  • Committer: Package Import Robot
  • Author(s): Graham Inggs
  • Date: 2013-07-07 20:33:10 UTC
  • Revision ID: package-import@ubuntu.com-20130707203310-a44yw80gqtc2s9ob
Tags: upstream-0.10.0
Import upstream version 0.10.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
eclox.core/src/eclox/core/doxyfiles/Chunk.java
 
1
/*******************************************************************************
 
2
 * Copyright (C) 2003, 2004, 2007, 2013, Guillaume Brocker
 
3
 * 
 
4
 * All rights reserved. This program and the accompanying materials
 
5
 * are made available under the terms of the Eclipse Public License v1.0
 
6
 * which accompanies this distribution, and is available at
 
7
 * http://www.eclipse.org/legal/epl-v10.html
 
8
 *
 
9
 * Contributors:
 
10
 *     Guillaume Brocker - Initial API and implementation
 
11
 *
 
12
 ******************************************************************************/ 
 
13
 
 
14
package eclox.core.doxyfiles;
 
15
 
 
16
 
 
17
/**
 
18
 * Implements the default item that can be contained in a doxyfile.
 
19
 * 
 
20
 * A chunk is a piece of text extracted from e doxyfile. It can represent comments,
 
21
 * empty lines or whatever.
 
22
 * 
 
23
 * @author Guillaume Brocker
 
24
 */
 
25
public abstract class Chunk {
 
26
        
 
27
        /**
 
28
         * the chunk owner (aka the doxyfile)
 
29
         */
 
30
        private Doxyfile owner;
 
31
        
 
32
        /**
 
33
         * Retrieves the chunk owner.
 
34
         * 
 
35
         * @return      the chunk owner
 
36
         */
 
37
        public Doxyfile getOwner() {
 
38
                return owner;
 
39
        }
 
40
        
 
41
        /**
 
42
         * Updates the chunk owner
 
43
         * 
 
44
         * @param       owner   the new owner
 
45
         */
 
46
        public void setOwner( Doxyfile owner ) {
 
47
                this.owner = owner; 
 
48
        }
 
49
        
 
50
        /**
 
51
         * Converts the chunk into a string representing its content.
 
52
         * 
 
53
         * @return      a string containing the chunk content
 
54
         */
 
55
        public abstract String toString();
 
56
        
 
57
}