jtopenlite.com.ibm.jtopenlite.command.CommandResult Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jt400-jdk6 Show documentation

The Open Source version of the IBM Toolbox for Java

There is a newer version: 11.1

///////////////////////////////////////////////////////////////////////////////
//
// JTOpenLite
//
// Filename:  CommandResult.java
//
// The source code contained herein is licensed under the IBM Public License
// Version 1.0, which has been approved by the Open Source Initiative.
// Copyright (C) 2011-2012 International Business Machines Corporation and
// others.  All rights reserved.
//
///////////////////////////////////////////////////////////////////////////////

package com.ibm.jtopenlite.command;

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

import com.ibm.jtopenlite.*;

/**
 * The result of calling a program or command.
 * @see CommandConnection#call
 * @see CommandConnection#execute
**/
public class CommandResult
{
  private boolean success_;
  private Message[] messages_;
  private List messageList_; 
  private int rc_;

  CommandResult(boolean success, Message[] messages, int rc)
  {
    success_ = success;
    messages_ = messages;
    messageList_ = null; 
    rc_ = rc;
  }

  CommandResult(boolean success, List messages, int rc)
  {
    success_ = success;
    messages_ = null; 
    messageList_ = messages; 
    rc_ = rc;
  }

  /**
   * Returns true if the call was successful.
  **/
  public boolean succeeded()
  {
    return success_;
  }

  /**
   * Returns the return code from the call, if any.
  **/
  public int getReturnCode()
  {
    return rc_;
  }

  /**
   * Returns any messages that were issued during the call.
  **/
  public Message[] getMessages()
  {
	  if (messages_ == null) {
		  if (messageList_ != null) { 
		    int size = messageList_.size();
		    messages_ = new Message[size];
		    for (int i = 0; i < size; i++) {
		    	messages_[i]=messageList_.get(i); 
		    }
		  }
	  }
	  return messages_;
  }

	public List getMessagesList() {
		if (messageList_ == null) {
			if (messages_ != null) {
				messageList_ = new LinkedList();
				for (int i = 0; i < messages_.length; i++) {
					messageList_.add(messages_[i]);
				}
			}
		}
		return messageList_;
	}
  
  public String toString()
  {
    // Use string buffer to improve performance 
    StringBuffer s = new StringBuffer(""+success_);
    s.append("; rc=0x"); 
    s.append(Integer.toHexString(rc_));
    if (messageList_ != null) {
    	getMessages(); 
    }
    if (messages_ != null)
    {
      for (int i=0; i