File: Operation.java

package info (click to toggle)
natbraille 2.0rc3-14
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 7,080 kB
  • sloc: java: 31,266; xml: 7,747; sh: 165; haskell: 50; makefile: 32
file content (218 lines) | stat: -rw-r--r-- 5,616 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/**************************************************************************
/* The base class for image-based commandline operations.
/*
/* Copyright (c) 2009 by Bernhard Bablok (mail@bablokb.de)
/*
/* This program is free software; you can redistribute it and/or modify
/* it under the terms of the GNU Library General Public License as published
/* by  the Free Software Foundation; either version 2 of the License or
/* (at your option) any later version.
/*
/* This program is distributed in the hope that it will be useful, but
/* WITHOUT ANY WARRANTY; without even the implied warranty of
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
/* GNU Library General Public License for more details.
/*
/* You should have received a copy of the GNU Library General Public License
/* along with this program; see the file COPYING.LIB.  If not, write to
/* the Free Software Foundation Inc., 59 Temple Place - Suite 330,
/* Boston, MA  02111-1307 USA
/**************************************************************************/

package org.im4java.core;

import java.util.LinkedList;
import java.util.List;

/**
   This class models the command-line of an image-command. 
   Objects of this class hold the arguments in a list and keep
   track of special "dynamic" operations.

   @version $Revision: 1.6 $
   @author  $Author: bablokb, Bruno Mascret (warnings) $
*/

public  class Operation {

  //////////////////////////////////////////////////////////////////////////////

  /**
     Placeholder-string for images.
  */

  public final static String IMG_PLACEHOLDER = "?img?";

  //////////////////////////////////////////////////////////////////////////////

  /**
     Placeholder-string for dynamic operations.
  */

  final static String DOP_PLACEHOLDER = "?dop?";

  //////////////////////////////////////////////////////////////////////////////

  /**
     The list of command-line arguments.
  */

  LinkedList<String> iCmdArgs = null;

  //////////////////////////////////////////////////////////////////////////////

  /**
     DynamicOperations for this Operation.
  */

  private LinkedList<DynamicOperation> iDynamicOperations = null;

  //////////////////////////////////////////////////////////////////////////////

  /**
     Constructor.
  */

  public Operation() {
    iCmdArgs           = new LinkedList<String>();
    iDynamicOperations = new LinkedList<DynamicOperation>();
  }

  //////////////////////////////////////////////////////////////////////////////

  /**
     Convert to String. Note that the arguments are not quoted!
  */

  public String toString() {
    StringBuffer buf = new StringBuffer();
    for (String arg:iCmdArgs) {
      buf.append(arg).append(" ");
    }
    return buf.toString();
  }

  //////////////////////////////////////////////////////////////////////////////

  /**
     Clone the (java) object. Note that ImageMagick has a -clone operator,
     therefore this class has a method clone() (inherited from  Core) which
     does not clone the java-object, but wraps the IM-clone operator!
  */

  public Operation cloneObject() {
    Operation op = new Operation();
    op.getCmdArgs().addAll(iCmdArgs);
    return op;
  }

  //////////////////////////////////////////////////////////////////////////////

  /**
     Add raw text to the list of arguments.
  */

  public Operation addRawArgs(String... pArgs) {
    for (String arg:pArgs) {
      iCmdArgs.add(arg);
    }
    return this;
  }

  //////////////////////////////////////////////////////////////////////////////

  /**
     Add raw text to the list of arguments.
  */

  public Operation addRawArgs(List<String> pArgs) {
    iCmdArgs.addAll(pArgs);
    return this;
  }

  //////////////////////////////////////////////////////////////////////////////

  /**
     Return the raw arguments.
  */

  public LinkedList<String> getCmdArgs() {
    return iCmdArgs;
  }

  //////////////////////////////////////////////////////////////////////////////

  /**
     Add image(s) to the operation.
  */

  public Operation addImage(String... pImages) {
    for (String img:pImages) {
      if (img != null) {
	iCmdArgs.add(img);
      }
    }
    return this;
  }

  //////////////////////////////////////////////////////////////////////////////

  /**
     Add an image-placeholder to an Operation.
  */

  public Operation addImage() {
    return addImage(1);
  }

  //////////////////////////////////////////////////////////////////////////////

  /**
     Add multiple image-placeholders to an Operation.
  */

  public Operation addImage(int n) {
    for (int i=0; i<n; ++i) {
      iCmdArgs.add(IMG_PLACEHOLDER);
    }
    return this;
  }

  //////////////////////////////////////////////////////////////////////////////

  /**
     Add an Operation.
  */

  public Operation addOperation(Operation pOperation) {
    return addRawArgs(pOperation.getCmdArgs());
  }


  ///////////////////////////////////////////////////////////////////////////////

  /**
   * Add a DynamicOperation to this Operation. We just save the DynamicOperation
   * in the internal list and add a placeholder for the operation.
   @param pOperation
   @return
  */

    public Operation addDynamicOperation(DynamicOperation pOperation) {
      iDynamicOperations.add(pOperation);
      iCmdArgs.add(DOP_PLACEHOLDER);
      return this;
    }


  ///////////////////////////////////////////////////////////////////////////////

    /**
     * Return the list of DynmicOperations.
     @return
    */

    public LinkedList<DynamicOperation> getDynamicOperations() {
      return iDynamicOperations;
    }
}