Bộ lập trình ICommand

public interface ICommandScheduler

com.android.tradefed.command.ICommandScheduler

Trình lập lịch biểu để chạy các lệnh TradeFederation.

Tóm tắt

Lớp lồng ghép

interface ICommandScheduler.IScheduledInvocationListener

Trình nghe các sự kiện gọi khi lệnh gọi hoàn tất. 

Phương thức công khai

abstract Pair<Boolean, Integer> addCommand(String[] args)

Thêm một lệnh vào trình lập lịch biểu.

abstract void addCommandFile(String cmdFile, extraArgs)

Thêm tất cả các lệnh từ tệp đã cho vào trình lập lịch biểu

abstract void await()

Chờ trình lập lịch biểu bắt đầu chạy, bao gồm cả chờ hoàn tất quá trình chuyển giao từ TF cũ nếu có.

abstract void displayCommandQueue(PrintWriter printWriter)

Xuất thông tin gỡ lỗi chi tiết về trạng thái của hàng đợi thực thi lệnh.

abstract void displayCommandsInfo(PrintWriter printWriter, String regex)

Xuất danh sách các lệnh hiện tại.

abstract void displayInvocationsInfo(PrintWriter printWriter)

Cho thấy danh sách lệnh gọi hiện tại.

abstract void dumpCommandsXml(PrintWriter printWriter, String regex)

Kết xuất tệp xml mở rộng cho lệnh bằng tất cả Đã chỉ định giá trị Option cho tất cả các lệnh hiện tại.

abstract long execCommand(IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args)

Phân bổ trực tiếp một thiết bị và thực thi một lệnh mà không cần thêm thiết bị đó vào hàng đợi lệnh bằng cách sử dụng IInvocationContext có sẵn.

abstract long execCommand(ICommandScheduler.IScheduledInvocationListener listener, String[] args)

Phân bổ trực tiếp một thiết bị và thực thi một lệnh mà không cần thêm thiết bị đó vào hàng đợi lệnh.

abstract long execCommand(ICommandScheduler.IScheduledInvocationListener listener, devices, String[] args)

Thực thi trực tiếp lệnh trên các thiết bị đã được phân bổ.

abstract CommandFileWatcher getCommandFileWatcher()

Tải CommandFileWatcher thích hợp cho trình lập lịch biểu này

abstract int getExecutingCommandCount()

Trả về số lượng Lệnh ở trạng thái thực thi.

abstract String getInvocationInfo(int invocationId)

Trả về thông tin trên một bu lệnh gọi chỉ định id gọi.

abstract CommandRunner.ExitCode getLastInvocationExitCode()

Trả về mã lỗi của lệnh gọi gần đây nhất đã chạy.

abstract Throwable getLastInvocationThrowable()

Trả về Throwable từ lệnh gọi gần đây nhất đã chạy.

abstract int getReadyCommandCount()

Trả về số lượng Lệnh ở trạng thái sẵn sàng trong hàng đợi.

abstract boolean isDeviceInInvocationThread(ITestDevice device)

Trả về true nếu thiết bị được một luồng lệnh gọi đang hoạt động sử dụng.

abstract void join()

Chờ trình lập lịch biểu hoàn tất.

abstract void join(long millis)

Chờ trình lập lịch biểu hoàn tất hoặc hết thời gian chờ sau khoảng thời gian được chỉ định bằng mili giây.

abstract void removeAllCommands()

Xoá tất cả các lệnh khỏi trình lập lịch biểu

abstract void setClearcutClient(ClearcutClient client)

Thiết lập ứng dụng để báo cáo dữ liệu khai thác

abstract boolean shouldShutdownOnCmdfileError()

Trả về giá trị true nếu chúng ta cần tắt trình lập lịch biểu khi gặp lỗi lệnh

default void shutdown()

Cố gắng tắt trình lập lịch biểu lệnh một cách linh hoạt.

abstract void shutdown(boolean notifyStop)

Cố gắng tắt trình lập lịch biểu lệnh một cách linh hoạt.

abstract void shutdownHard(boolean killAdb)

Cố gắng tắt trình lập lịch biểu lệnh.

abstract void shutdownHard()

Cố gắng tắt trình lập lịch biểu lệnh.

abstract void shutdownOnEmpty()

Tương tự như shutdown(), nhưng sẽ đợi tất cả các lệnh được thực thi trước khi thoát.

abstract void start()

Khởi động ICommandScheduler.

abstract boolean stopInvocation(int invocationId, String cause)

Dừng một lệnh gọi đang chạy bằng cách chỉ định mã nhận dạng của lệnh gọi đó.

default boolean stopInvocation(int invocationId)

Dừng một lệnh gọi đang chạy bằng cách chỉ định mã nhận dạng của lệnh gọi đó.

abstract boolean stopInvocation(ITestInvocation invocation)

Dừng một lệnh gọi đang chạy.

default void stopScheduling()

Ngừng lên lịch và chấp nhận các thử nghiệm mới nhưng không dừng Tradefeed.

Phương thức công khai

addCommand

public abstract Pair<Boolean, Integer> addCommand (String[] args)

Thêm một lệnh vào trình lập lịch biểu.

Lệnh về cơ bản là một thực thể của cấu hình cần chạy và đối số.

Nếu "--help" đối số được chỉ định, văn bản trợ giúp cho cấu hình sẽ được xuất tới stdout. Nếu không, cấu hình này sẽ được thêm vào hàng đợi để chạy.

Tham số
args String: các đối số cấu hình.
Giá trị trả về
Pair<Boolean, Integer> Một cặp giá trị, giá trị đầu tiên là true Boolean nếu lệnh đã được thêm thành công. Giá trị thứ hai là mã trình theo dõi lệnh đã biết(giá trị không âm) nếu lệnh đã được thêm thành công, hãy trả về 0 khi lệnh được thêm cho tất cả các thiết bị, nếu không -1.
Gửi
ConfigurationException không thể phân tích cú pháp lệnh if

addCommandFile

public abstract void addCommandFile (String cmdFile, 
                 extraArgs)

Thêm tất cả các lệnh từ tệp đã cho vào trình lập lịch biểu

Tham số
cmdFile String: đường dẫn hệ thống tệp của tệp comand
extraArgs : ERROR(/List) trong số String đối số để thêm vào mỗi lệnh được phân tích cú pháp khỏi tệp. Có thể để trống nhưng không được để trống.
Gửi
ConfigurationException nếu không thể phân tích cú pháp tệp lệnh

Xem thêm:

đang chờ

public abstract void await ()

Chờ trình lập lịch biểu bắt đầu chạy, bao gồm cả chờ hoàn tất quá trình chuyển giao từ TF cũ nếu có.

Hàng đợi displayCommand

public abstract void displayCommandQueue (PrintWriter printWriter)

Xuất thông tin gỡ lỗi chi tiết về trạng thái của hàng đợi thực thi lệnh.

displayCommandsInfo

public abstract void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

Xuất danh sách các lệnh hiện tại.

Tham số
printWriter PrintWriter: ERROR(/PrintWriter) để xuất dữ liệu.
regex String: biểu thức chính quy cần được so khớp để được đã in. Nếu giá trị rỗng thì tất cả lệnh sẽ được in.

displayInvocationsInfo

public abstract void displayInvocationsInfo (PrintWriter printWriter)

Cho thấy danh sách lệnh gọi hiện tại.

Tham số
printWriter PrintWriter: ERROR(/PrintWriter) để xuất dữ liệu.

dumpCommandsXml

public abstract void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

Kết xuất tệp xml mở rộng cho lệnh bằng tất cả Đã chỉ định giá trị Option cho tất cả các lệnh hiện tại.

Tham số
printWriter PrintWriter: ERROR(/PrintWriter) để xuất trạng thái.
regex String: biểu thức chính quy cần được so khớp để có xml được kết xuất. Nếu giá trị rỗng, mọi lệnh sẽ được kết xuất.

execCommand

public abstract long execCommand (IInvocationContext context, 
                ICommandScheduler.IScheduledInvocationListener listener, 
                String[] args)

Phân bổ trực tiếp một thiết bị và thực thi một lệnh mà không cần thêm thiết bị đó vào hàng đợi lệnh bằng cách sử dụng IInvocationContext có sẵn.

Tham số
context IInvocationContext: một IInvocationContext hiện có.
listener ICommandScheduler.IScheduledInvocationListener: ICommandScheduler.IScheduledInvocationListener cần nhận thông báo
args String: đối số lệnh
Giá trị trả về
long

Gửi
ConfigurationException lệnh if không hợp lệ
NoDeviceException không có thiết bị nào để sử dụng

execCommand

public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                String[] args)

Phân bổ trực tiếp một thiết bị và thực thi một lệnh mà không cần thêm thiết bị đó vào hàng đợi lệnh.

Tham số
listener ICommandScheduler.IScheduledInvocationListener: ICommandScheduler.IScheduledInvocationListener cần nhận thông báo
args String: đối số lệnh
Giá trị trả về
long Mã lệnh gọi của lệnh đã lên lịch.
Gửi
ConfigurationException lệnh if không hợp lệ
NoDeviceException không có thiết bị nào để sử dụng

execCommand

public abstract long execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                 devices, 
                String[] args)

Thực thi trực tiếp lệnh trên các thiết bị đã được phân bổ.

Tham số
listener ICommandScheduler.IScheduledInvocationListener: ICommandScheduler.IScheduledInvocationListener cần nhận thông báo
devices : ERROR(/List) để sử dụng
args String: đối số lệnh
Giá trị trả về
long Mã lệnh gọi của lệnh đã lên lịch.
Gửi
ConfigurationException lệnh if không hợp lệ

getCommandFileWatcher

public abstract CommandFileWatcher getCommandFileWatcher ()

Tải CommandFileWatcher thích hợp cho trình lập lịch biểu này

Giá trị trả về
CommandFileWatcher

getExecutingCommandCount

public abstract int getExecutingCommandCount ()

Trả về số lượng Lệnh ở trạng thái thực thi.

Giá trị trả về
int

getInvocationInfo

public abstract String getInvocationInfo (int invocationId)

Trả về thông tin trên một bu lệnh gọi chỉ định id gọi.

Tham số
invocationId int: mã theo dõi của lệnh gọi.
Giá trị trả về
String String chứa thông tin về lệnh gọi.

getLastInvocationExitCode

public abstract CommandRunner.ExitCode getLastInvocationExitCode ()

Trả về mã lỗi của lệnh gọi gần đây nhất đã chạy. Trả về 0 (không có lỗi) nếu chưa có lệnh gọi nào chạy.

Giá trị trả về
CommandRunner.ExitCode

getLastInvocationThrowable

public abstract Throwable getLastInvocationThrowable ()

Trả về Throwable từ lệnh gọi gần đây nhất đã chạy. Trả về giá trị rỗng nếu không có lớp throwable.

Giá trị trả về
Throwable

getSẵn LệnhCount

public abstract int getReadyCommandCount ()

Trả về số lượng Lệnh ở trạng thái sẵn sàng trong hàng đợi.

Giá trị trả về
int

isDeviceInvocationThread

public abstract boolean isDeviceInInvocationThread (ITestDevice device)

Trả về true nếu thiết bị được một luồng lệnh gọi đang hoạt động sử dụng.

Tham số
device ITestDevice

Giá trị trả về
boolean

tham gia

public abstract void join ()

Chờ trình lập lịch biểu hoàn tất.

Xem thêm:

tham gia

public abstract void join (long millis)

Chờ trình lập lịch biểu hoàn tất hoặc hết thời gian chờ sau khoảng thời gian được chỉ định bằng mili giây.

Tham số
millis long

Xem thêm:

removeAllCommands

public abstract void removeAllCommands ()

Xoá tất cả các lệnh khỏi trình lập lịch biểu

setClearcutClient

public abstract void setClearcutClient (ClearcutClient client)

Thiết lập ứng dụng để báo cáo dữ liệu khai thác

Tham số
client ClearcutClient

nênTắtOnCmdfileError

public abstract boolean shouldShutdownOnCmdfileError ()

Trả về giá trị true nếu chúng ta cần tắt trình lập lịch biểu khi gặp lỗi lệnh

Giá trị trả về
boolean

tắt máy

public void shutdown ()

Cố gắng tắt trình lập lịch biểu lệnh một cách linh hoạt.

Xoá các lệnh đang chờ kiểm thử và yêu cầu tắt tất cả lệnh gọi đang diễn ra xuống một cách nhẹ nhàng.

Sau khi gọi quá trình tắt, vòng lặp chính của trình lập lịch biểu sẽ đợi tất cả lệnh gọi trong để hoàn tất trước khi thoát hoàn toàn.

tắt máy

public abstract void shutdown (boolean notifyStop)

Cố gắng tắt trình lập lịch biểu lệnh một cách linh hoạt.

Tham số
notifyStop boolean: nếu đúng, sẽ thông báo cho lệnh gọi tắt TF.

CANNOT TRANSLATE

public abstract void shutdownHard (boolean killAdb)

Cố gắng tắt trình lập lịch biểu lệnh.

Tương tự như shutdown(), nhưng cũng sẽ tuỳ ý loại bỏ kết nối adb, trong một cố gắng 'truyền cảm hứng' đang thực hiện lệnh gọi để hoàn tất nhanh hơn.

Tham số
killAdb boolean

CANNOT TRANSLATE

public abstract void shutdownHard ()

Cố gắng tắt trình lập lịch biểu lệnh. Tương tự như TẮTHard(true).

tắt máy khi trống

public abstract void shutdownOnEmpty ()

Tương tự như shutdown(), nhưng sẽ đợi tất cả các lệnh được thực thi trước khi thoát.

Lưu ý rằng nếu có bất kỳ lệnh nào ở chế độ lặp lại, thì trình lập lịch biểu sẽ không bao giờ thoát.

start

public abstract void start ()

Khởi động ICommandScheduler.

Phải được gọi trước khi gọi các phương thức khác.

Sẽ chạy cho đến khi shutdown() được gọi. xem Thread.start().

dừngGọi

public abstract boolean stopInvocation (int invocationId, 
                String cause)

Dừng một lệnh gọi đang chạy bằng cách chỉ định mã nhận dạng của lệnh gọi đó.

Tham số
invocationId int: mã theo dõi của lệnh gọi.
cause String: nguyên nhân khiến lệnh gọi dừng hoạt động.
Giá trị trả về
boolean true nếu lệnh gọi bị dừng, false nếu không gọi
Gửi
UnsupportedOperationException nếu quá trình triển khai không hỗ trợ điều này

dừngGọi

public boolean stopInvocation (int invocationId)

Dừng một lệnh gọi đang chạy bằng cách chỉ định mã nhận dạng của lệnh gọi đó.

Tham số
invocationId int

Giá trị trả về
boolean true nếu lệnh gọi bị dừng, false nếu không gọi
Gửi
UnsupportedOperationException nếu quá trình triển khai không hỗ trợ điều này

dừngGọi

public abstract boolean stopInvocation (ITestInvocation invocation)

Dừng một lệnh gọi đang chạy.

Tham số
invocation ITestInvocation

Giá trị trả về
boolean true nếu lệnh gọi bị dừng, false nếu không gọi
Gửi
UnsupportedOperationException nếu quá trình triển khai không hỗ trợ điều này

dừngLập lịch

public void stopScheduling ()

Ngừng lên lịch và chấp nhận các thử nghiệm mới nhưng không dừng Tradefeed. Điều này nhằm bật ngừng hoạt động hai bước, trong đó trước tiên chúng tôi loại bỏ tất cả các kiểm thử đang chạy, sau đó chấm dứt Tradefeed của chúng tôi.